IPCsSymbol

Topic:

Properties and methods of IPCsSymbol

Class hierarchy:

IPCsApplication IPCsDocument IPCsPage IPCsSymbols IPCsSymbol
IPCsApplication IPCsDocument IPCsSelectStatus SelectedSymbol
IPCsApplication IPCsDocument IPCsSelectStatus IPCsSelectionArea IPCsSymbols IPCsSymbol

Properties / Methods:

GetRect Used for getting coordinates from where the symbol is placed on the diagram. Parameters needed: a psSymbolRectType . Returns a TPCsRect
Syntax:function GetRect(AType: PsSymbolRectType): TPCsRect;

LibType See more IPCsLibType

Layer See more IPCsLayer

Fullname Name of the item. The name is the result of 3 strings. To get these strings separately see under Symbols[x].SymbolTexts.NameText

Delete Deletes the symbol

Connections See more IPCsConnections

Rotation Set the orientation/rotation of the symbol

SymbolTexts See more IPCsSymbolTexts

SymbolType1 The type the symbol is. More on this psSymbolType

SymbolType2 The second type the symbol is, (if used) psSymbolType

ComponentGroupNo Groupnumber for the item. This groupnumber should be set if 2 of the same items are used, and has the same name. If your project makes a pcs-list, it won't show 2 of that type, unless it has different groupnumbers.

ComponentPosNo Similar to ComponentGroupNo, but only relevant to terminals.

GetPosition Gets x,y,z from a symbol. Parameters needed: 3 integers
Syntax:procedure GetPosition(out X: Integer; out Y: Integer; out Z: Integer);

SetPosition Sets x,y,z on a symbol. Parameters needed: 3 integers
Syntax:procedure SetPosition(X: Integer; Y: Integer; Z: Integer);

Visible Is the item visible or not

Handle A unique handle to the symbol

State An integer, that indicates what state the symbol is in.

Datafields The symbols datafields. See more IPCsDatafields

Reference The symbols reference. See more IPCsReference

WithReference True if symbol has a reference.

IsVMirrored True if the symbol is mirrored around a vertical axis.

IsHMirrored True if the symbol is mirrored around a horizontal axis.

UpdateFromDatabase Updates the symbol from the database.

Comments:

Use Symbols.Item[interger] and Symbols.Count to get that/these items you want.
IPCsSymbols gives access to all symbols on a page through Item[integer].
IPCsSymbol is a specific symbol, (which can be selected through IPCsSymbols.Item[integer])

GetRect	Used for getting coordinates from where the symbol is placed on the diagram. Parameters needed: a psSymbolRectType . Returns a TPCsRect Syntax:function GetRect(AType: PsSymbolRectType): TPCsRect;
LibType	See more IPCsLibType
Layer	See more IPCsLayer
Fullname	Name of the item. The name is the result of 3 strings. To get these strings separately see under Symbols[x].SymbolTexts.NameText
Delete	Deletes the symbol
Connections	See more IPCsConnections
Rotation	Set the orientation/rotation of the symbol
SymbolTexts	See more IPCsSymbolTexts
SymbolType1	The type the symbol is. More on this psSymbolType
SymbolType2	The second type the symbol is, (if used) psSymbolType
ComponentGroupNo	Groupnumber for the item. This groupnumber should be set if 2 of the same items are used, and has the same name. If your project makes a pcs-list, it won't show 2 of that type, unless it has different groupnumbers.
ComponentPosNo	Similar to ComponentGroupNo, but only relevant to terminals.
GetPosition	Gets x,y,z from a symbol. Parameters needed: 3 integers Syntax:procedure GetPosition(out X: Integer; out Y: Integer; out Z: Integer);
SetPosition	Sets x,y,z on a symbol. Parameters needed: 3 integers Syntax:procedure SetPosition(X: Integer; Y: Integer; Z: Integer);
Visible	Is the item visible or not
Handle	A unique handle to the symbol
State	An integer, that indicates what state the symbol is in.
Datafields	The symbols datafields. See more IPCsDatafields
Reference	The symbols reference. See more IPCsReference
WithReference	True if symbol has a reference.
IsVMirrored	True if the symbol is mirrored around a vertical axis.
IsHMirrored	True if the symbol is mirrored around a horizontal axis.
UpdateFromDatabase	Updates the symbol from the database.