IPCsPage

Topic:

Properties and methods of IPCsPage

Class hierarchy:

IPCsApplication IPCsDocument IPCsPages IPCsPage

Properties / Methods:

LoadPageHeader Used to insert a pageheader. Parameters needed: a filename (widestring).
Returns true, if pageheader inserted is succesful
Syntax:function LoadPageHeader(const Filename : WideString): WordBool;

PlaceSymbol Used to create a symbol. Parameters needed: a TPCsPoint3D , and a filename (widestring). Returns a IPCsSymbol
Syntax:function PlaceSymbol(Pt: TPCsPoint3D; const Filename: WideString): IPCsSymbol;

Symbols See more IPCsSymbols

Texts See more IPCsTexts

Title The caption in the statusbar, for that particular page

Lines See more IPCsLines

Arcs See more IPCsArcs

PageType The type of the page. Read more psPageType

PageFunction The function of the page. Read more psPageFunction

PageNumber Set the caption on the pagetab.

Scale Set the scale of the current page. A scale of 0.2 will in Automation be shown as 1:5. A scale of 0.01 will be shown in Automation as 1:100. In other words: 1 divided by scale value, result in the scale shown in Automation.

PageSetup See more IPCsPageSetup

PageReference See more IPCsPageReference

RefDesLocation Location aspect of referencedesignation

RefDesFunction Function aspect of referencedesignation

PrintOut Prints the page immediately on the default printer

Index The pageindex for the page

PageDataCount The length of the PageData-array

PageData Array of widestrings, that holds the values to the pagedata of the page. The length of the array is determined by PageDataCount.

Origo Get or set the origo on the page. Type is TPCsPoint3D

UpdateReference Updates the references on the page. This method must be called in a special way:
var
PCsApplication: IPCsApplication;
OleResult : OleVariant;

// Use an IPCsPage an parse it as IPCsBase. In this example the currently active page is used.

(PCsApplication.ActiveDocument.ActivePage as IPCsBase).CustomCommand('UpdateReference', 0, OleResult);

Comments:

From IPCsPages it possible to create, modify or delete Symbols, Texts, Lines, Arcs and Datafields in a diagram.
IPCsPages gives access to all pages in the project through Item[integer].
IPCsPage is a specific page, (which can be selected through IPCsPages.Item[integer]

LoadPageHeader	Used to insert a pageheader. Parameters needed: a filename (widestring). Returns true, if pageheader inserted is succesful Syntax:function LoadPageHeader(const Filename : WideString): WordBool;
PlaceSymbol	Used to create a symbol. Parameters needed: a TPCsPoint3D , and a filename (widestring). Returns a IPCsSymbol Syntax:function PlaceSymbol(Pt: TPCsPoint3D; const Filename: WideString): IPCsSymbol;
Symbols	See more IPCsSymbols
Texts	See more IPCsTexts
Title	The caption in the statusbar, for that particular page
Lines	See more IPCsLines
Arcs	See more IPCsArcs
PageType	The type of the page. Read more psPageType
PageFunction	The function of the page. Read more psPageFunction
PageNumber	Set the caption on the pagetab.
Scale	Set the scale of the current page. A scale of 0.2 will in Automation be shown as 1:5. A scale of 0.01 will be shown in Automation as 1:100. In other words: 1 divided by scale value, result in the scale shown in Automation.
PageSetup	See more IPCsPageSetup
PageReference	See more IPCsPageReference
RefDesLocation	Location aspect of referencedesignation
RefDesFunction	Function aspect of referencedesignation
PrintOut	Prints the page immediately on the default printer
Index	The pageindex for the page
PageDataCount	The length of the PageData-array
PageData	Array of widestrings, that holds the values to the pagedata of the page. The length of the array is determined by PageDataCount.
Origo	Get or set the origo on the page. Type is TPCsPoint3D
UpdateReference	Updates the references on the page. This method must be called in a special way: var PCsApplication: IPCsApplication; OleResult : OleVariant; // Use an IPCsPage an parse it as IPCsBase. In this example the currently active page is used. (PCsApplication.ActiveDocument.ActivePage as IPCsBase).CustomCommand('UpdateReference', 0, OleResult);