Schematic API Design Objects Interfaces

Old Content - visit altium.com/documentation

Parent page: Technical Reference - Schematic API

Schematic API: Design Objects Interfaces Reference

The Schematic API Design Objects reference includes the following content:

ISch_Arc Interface
ISch_Bezier Interface
ISch_Bus Interface
ISch_BusEntry Interface
ISch_Circle Interface
ISch_CompileMask Interface
ISch_ComplexText Interface
ISch_Component Interface
ISch_ConnectionLine Interface
ISch_CrossSheetConnector Interface
ISch_Designator Interface
ISch_Directive Interface
ISch_Ellipse
ISch_EllipticalArc Interface
ISch_ErrorMarker Interface
ISch_HarnessConnector Interface

ISch_HarnessConnectorType Interface
ISch_HarnessEntry Interface
ISch_Image Interface
ISch_Junction Interface
ISch_Label Interface
ISch_Line Interface
ISch_NetLabel Interface
ISch_NoERC Interface
ISch_Note Interface
ISch_Parameter Interface
ISch_ParameterSet Interface
ISch_ParametrizedGroup Interface
ISch_Pie Interface
ISch_Pin Interface
ISch_Polygon Interface
ISch_Polyline Interface

ISch_Port Interface
ISch_PowerObject Interface
ISch_Probe Interface
ISch_Rectangle Interface
ISch_RectangularGroup Interface
ISch_RoundRectangle Interface
ISch_SheetEntry Interface
ISch_SheetFileName Interface
ISch_SheetName Interface
ISch_SheetSymbol Interface
ISch_Symbol Interface
ISch_Template Interface
ISch_TextFrame Interface
ISch_Wire Interface

A schematic design object on a schematic document is represented by its interface. An interface represents an existing object in memory and its properties and methods can be invoked.

Since many design objects are descended from ancestor interfaces and thus the ancestor methods and properties are also available to use. For example the ISch_Image interface is inherited from an immediate ISch_Rectangle interface and in turn inherited from the ISch_GraphicalObject interface. If you check the ISCh_Image entry in this reference you will see the following information:

The ISch_Image interface hierarchy is as follows:
ISch_GraphicalObject
    ISch_Rectangle
        ISch_Image

ISch_Rectangle properties
Corner    : TLocation
LineWidth : TSize   
IsSolid   : Boolean 

ISch_Image Properties
EmbedImage : Boolean  
FileName   : WideString
KeepAspect : Boolean  

Therefore you have the Image object properties, along with ISch_Rectangle methods and properties AND the ISch_GraphicalObject methods and properties to use in scripts.

ISch_Arc Interface

Overview
An arc object is a circular curve used to place on the schematic sheet.
Notes
The ISch_Arc interface hierarchy is as follows:
ISch_GraphicalObject
    ISch_Arc

ISch_Arc methods
GetState_Radius
GetState_StartAngle
GetState_EndAngle
GetState_LineWidth
SetState_Radius
SetState_StartAngle
SetState_EndAngle
SetState_LineWidth
ISch_Arc properties
Radius
StartAngle
EndAngle
LineWidth

See also

Methods

All methods are implemented by the ISch_Arc properties. More information for each property of the ISch_Arc interface is presented in the Properties section.

Properties

StartAngle property

(ISch_Arc interface)
Syntax
Property StartAngle : TAngle Read GetState_StartAngle Write SetState_StartAngle;
Description
This property defines the start angle of the arc in degrees from the horizontal. The arc is drawn in an anti-clockwise direction from the start angle to the end angle. The value can be between -360 to 360 to define the start angle directly.
Example
See also
ISch_Arc interface
TAngle type

Radius property

(ISch_Arc interface)
Syntax
Property Radius : TDistance Read GetState_Radius Write SetState_Radius ;
Description
The Radius property defines the radius of the arc. This property is supported by the GetState_Radius and SetState_Radius methods.
Example
See also
ISch_Arc interface
TDistance type

LineWidth property

(ISch_Arc interface)
Syntax
Property LineWidth : TSize Read GetState_LineWidth Write SetState_LineWidth ;
Description
The LineWidth property defines the border width of the arc with one of the following values from the TSize enumerated type. This property is supported by the GetState_LineWidth and SetState_LineWidth methods.
Example
Arc.LineWidth := eMedium;
See also
TSize Type
ISch_Arc interface

EndAngle property

(ISch_Arc interface)
Syntax
Property EndAngle : TAngle Read GetState_EndAngle Write SetState_EndAngle ;
Description
This property defines the end angle of the arc in degrees from the horizontal. The arc is drawn in an anti-clockwise direction from the start angle to the end angle. The value can be between -360 to 360 to define the end angle directly.
Example
See also
ISch_Arc interface
TAngle type

ISch_Bezier Interface

Overview
A bezier curve is used to create curved line shapes (For example a section of a sine wave or a pulse).  At least four points are required to define a bezier curve.  More than four points used will define another bezier curve and so on.
The ISch_Bezier interface hierarchy is as follows:
ISch_GraphicalObject
    ISch_Polygon
        ISch_BasicPolyline
            ISch_Bezier

ISch_Bezier methods ISch_Bezier properties

See also

ISch_Bus Interface

Overview
Buses are special graphical elements that represent a common pathway for multiple signals on a schematic document.  Buses have no electrical properties, and they must be correctly identified by net labels and ports.
Notes
The ISch_Bus interface hierarchy is as follows:
ISch_GraphicalObject
    ISch_Polygon
        ISch_Polyline
            ISch_Wire
                ISch_Bus
Note that the ISch_Wire interface has no extra properties and methods  but has inherited properties and methods only.

ISch_Bus methods ISch_Bus properties

See also
ISch_Wire
ISch_Polyline
ISCh_Polygon
ISch_GraphicalObject

ISch_BusEntry Interface

Overview
A bus entry is a special wire at an angle of 45 degrees which is used to connect a wire to the bus line.
The ISch_BusEntry interface hierarchy is as follows:
ISch_GraphicalObject
    ISch_Line
        ISch_BusEntry

ISch_BusEntry methods ISch_BusEntry properties

See also
ISch_Line interface

ISch_Circle Interface

Overview
A circle is a closed arc object.
The ISch_Circle interface hierarchy is as follows:
ISch_GraphicalObject
    ISch_Circle

ISch_Circle methods
SetState_LineWidth
SetState_IsSolid
SetState_Radius
SetState_Transparent
GetState_LineWidth
GetState_IsSolid
GetState_Radius
GetState_Transparent
ISch_Circle properties
LineWidth
IsSolid
Radius
Transparent

See also
ISch_GraphicalObject interface
TSize type
TDistance type

Methods

All methods are implemented by the ISch_Circle properties. More information for each property of the ISch_Circle interface is presented in the Properties section.

Properties

LineWidth property

(ISch_Circle interface)
Syntax
Property LineWidth : TSize Read GetState_LineWidth Write SetState_LineWidth;
Description
The LineWidth property defines the border width of the circle with one of the following values from the TSize enumerated type. This property is supported by the GetState_LineWidth and SetState_LineWidth methods.
Example
Circle.LineWidth := eLarge;
See also
TSize type.
ISch_Circle interface

IsSolid property

(ISch_Circle interface)
Syntax
Property IsSolid : Boolean Read GetState_IsSolid Write SetState_IsSolid;
Description
This property defines whether the circle is to be filled inside or not. If it is true, the circle is filled with the color set by the AreaColor property (from its ancestor ISch_GraphicalObject interface).
This property is supported by the GetState_IsSolid and SetState_IsSolid methods.
Example

If Circle.IsSolid Then
    Circle.AreaColor := 0; // black fill.

See also
ISch_Circle interface

Radius property

(ISch_Circle interface)
Syntax
Property Radius : TDistance Read GetState_Radius Write SetState_Radius;
Description
The Radius property defines the radius of the circle (pie chart). This property is supported by the GetState_Radius and SetState_Radius methods.
Example
See also
ISch_Circle interface
TDistance type

Transparent property

(ISch_Circle interface)
Syntax
Property Transparent : Boolean Read GetState_Transparent Write SetState_Transparent;
Description
This transparent property toggles the transparency of this circle object. This property is supported by the GetState_Transparent and SetState_Transparent methods.
Example
See also
ISch_Circle interface

ISch_CompileMask Interface

Overview
A compile mask is used to effectively hide the area of the design within the PCB project it contains from the Compiler, allowing you to manually prevent error checking for circuitry that may not yet be complete and you know will generated compile errors.

This can prove very useful if you need to compile the active document or project to check the integrity of the design in other specific areas, but do not want the clutter of compiler-generated messages associated with unfinished portions of the design.

The CompileMask object hold multiple lines of free text that can be collapsed or not.

The ISch_CompileMask interface hierarchy is as follows:
ISch_GraphicalObject
    ISch_Rectangle
        ISch_CompileMask

ISch_CompileMask methods
SetState_Collapsed
GetState_Collapsed
ISch_CompileMask properties
Collapsed

See also
ISch_Rectangle interface

Methods

All methods are implemented by the ISch_CompileMask properties. More information for each property of the ISch_CompileMask interface is presented in the Properties section.

Properties

Collapsed property

(ISch_CompileMask interface)
Syntax
Property Collapsed : Boolean Read GetState_Collapsed Write SetState_Collapsed;
Description
When the property is false, the compile mask is collapsed and disabled. When this property is true, the compile mask is fully expanded and enabled meaning the portion of the schematic covered by the Compile Mask object is not affected by the Compiler.
This property is supported by the GetState_Collapsed and SetState_Collapsed methods.
Example
See also
ISch_CompileMask interface

ISch_ComplexText Interface

Overview
An immediate ancestor interface for ISch_SheetFilename and ISch_SheetName interfaces.

The ISch_ComplexText interface hierarchy is as follows:
ISch_GraphicalObject
    ISch_Label
        ISch_ComplexText

ISch_ComplexText methods
SetState_Autoposition
SetState_IsHidden
SetState_TextHorzAnchor
SetState_TextVertAnchor
GetState_Autoposition
GetState_IsHidden
GetState_TextHorzAnchor
GetState_TextVertAnchor
ISch_ComplexText properties
Autoposition
IsHidden
TextHorzAnchor
TextVertAnchor

See also

Methods

GetState_Autoposition method

(ISch_ComplexText interface)
Syntax
Function GetState_Autoposition : Boolean;
Description
The property defines whether the parameter can be positioned automatically every time the associated component is rotated or moved. If this property is false, the parameter will have a dot appear below it on the schematic to denote that this parameter will not be auto positioned everytime the component is rotated/moved.

The function reads the autoposition value and is used for the Autoposition property.

To prevent dots form being displayed, disable the MarkManualParameters property from the ISch_Preferences interface.
Example
See also
ISch_ComplexText interface

GetState_IsHidden method

(ISch_ComplexText interface)
Syntax
Function GetState_IsHidden : Boolean;
Description
The property determines whether the text object is hidden or not. This method obtains the boolean value whether the complex text (a parameter object) is hidden or not and is used in the IsHidden property.
Example
See also
ISch_ComplexText interface

GetState_TextVertAnchor method

(ISch_ComplexText interface)
Syntax
Function GetState_TextVertAnchor : TTextVertAnchor;
Description
The TextVertAnchor property defines the vertical justification style of the parameter object.
The method obtains the vertical justification style of the object represented by the ISch_ComplexText interface and is used for the TextVertAnchor property.
Example
See also
ISch_ComplexText interface
TTextVertAnchor type

GetState_TextHorzAnchor method

(ISch_ComplexText interface)
Syntax
Function GetState_TextHorzAnchor : TTextHorzAnchor;
Description
The TextHorzAnchor property defines the horizontal justification style of the parameter object.
The method obtains the horizontal justification style of the object represented by the ISch_ComplexText interface and is used for the TextHorzAnchor property.
Example
See also
ISch_ComplexText interface

SetState_TextVertAnchor method

(ISch_ComplexText interface)
Syntax
Procedure SetState_TextVertAnchor (A : TTextVertAnchor);
Description
The TextVertAnchor property defines the vertical justification style of the parameter object. The function sets the vertical justification of the parameter object and is used for the TextVertAnchor property.
Example
See also
ISch_ComplexText interface

SetState_TextHorzAnchor method

(ISch_ComplexText interface)
Syntax
Procedure SetState_TextHorzAnchor (A : TTextHorzAnchor);
Description
The TextHorzAnchor property defines the horizontal justification style of the parameter object.
The method obtains the horizontal justification style of the object represented by the ISch_ComplexText interface and is used for the TextHorzAnchor property.
Example
See also
ISch_ComplexText interface

SetState_IsHidden method

(ISch_ComplexText interface)
Syntax
Procedure SetState_IsHidden (B : Boolean);
Description
The property determines whether the text object is hidden or not. This method sets the boolean value whether the complex text (a parameter object) is hidden or not and is used in the IsHidden property.
Example
See also
ISch_ComplexText interface

SetState_Autoposition method

(ISch_ComplexText interface)
Syntax
Procedure SetState_Autoposition (B : Boolean);
Description
The property defines whether the parameter can be positioned automatically every time the associated component is rotated or moved. If this property is false, the parameter will have a dot appear below it on the schematic to denote that this parameter will not be auto positioned everytime the component is rotated/moved.

The procedure sets the value for autoposition of parameters and is used for the Autoposition property.

To prevent dots form being displayed, disable the MarkManualParameters property from the ISch_Preferences interface.
Example
See also
ISch_ComplexText interface

Properties

Autoposition property

(ISch_ComplexText interface)
Syntax
Property Autoposition : Boolean Read GetState_Autoposition Write SetState_Autoposition;
Description
The property defines whether the parameter can be positioned automatically every time the associated component is rotated or moved. If this property is false, the parameter will have a dot appear below it on the schematic to denote that this parameter will not be auto positioned everytime the component is rotated/moved.

To prevent dots form being displayed, disable the MarkManualParameters property from the ISch_Preferences interface.
Example
See also
ISch_ComplexText interface

IsHidden property

(ISch_ComplexText interface)
Syntax
Property IsHidden : Boolean Read GetState_IsHidden Write SetState_IsHidden;
Description
The property determines whether the text object is hidden or not. This property is supported by the GetState_IsHidden and SetState_IsHidden methods.
Example
See also
ISch_ComplexText interface

TextVertAnchor property

(ISch_ComplexText interface)
Syntax
Property TextVertAnchor : TTextVertAnchor Read GetState_TextVertAnchor Write SetState_TextVertAnchor;
Description
This property defines the vertical justification style of the parameter object. This property is supported by the GetState_TextVertAnchor and SetState_TextVertAnchor methods.
Example
See also
ISch_ComplexText interface
TTextVertAnchor type

TextHorzAnchor property

(ISch_ComplexText interface)
Syntax
Property TextHorzAnchor : TTextHorzAnchor Read GetState_TextHorzAnchor Write SetState_TextHorzAnchor;
Description
This property defines the horizontal justification style of the parameter object. This property is supported by the GetState_TextHorzAnchor and SetState_TextHorzAnchor methods.
Example
See also
ISch_ComplexText interface
TTextHorzAnchor type

ISch_Component Interface

Overview
The ISch_Component references the logical symbol as a component that can contain links to different model implementations such as PCB, Signal Integrity and Simulation models. Only one model of a particular model type (PCB footprint, SIM, SI, EDIF Macro and VHDL) can be enabled as the currently linked model, at any one time.

Each schematic component has two system parameters – the Designator parameter and the Comment parameter. Custom parameters can be added anytime. The Comment parameter can be assigned an indirect name parameter. Once a name parameter (with a equal sign character as a prefix to the name parameter) is assigned to the Comment field of the Component properties dialog, the value for this parameter appears on the document, ensure that the Convert Special Strings option in the Schematic Preferences dialog is enabled.

The Unique ID (UID) is an system generated value that uniquely identifies this current component. It is used for linking to an associated PCB component on a PCB document. Enter a new UID value or click the Reset button to generate a new UID if you wish to force the Schematic component to be linked to a different PCB component. You will need to run the Component Links... dialog to update the linkage on the corresponding PCB document.
This SourceLibraryName property denotes the source library where the symbol and its associated model links are from. The * character in this field denotes the current library of the current project. Note a schematic component is a symbol with a defined designator placed on a schematic document.

The LibraryRef property is the name of the symbol. The symbol is from the library specified in the Library field below.
The SheetPartyFilename property, enter a sub design project file name to be linked to the current schematic component. An example of a sub design project is a programmable logic device project or a schematic sub-sheet.

Notes
The ISch_Component interface hierarchy is as follows:
ISch_GraphicalObject
    ISch_ParametrizedGroup
        ISch_Component

ISch_Component methods
GetState_AliasAsText
GetState_AliasAt
GetState_AliasCount
GetState_ComponentDescription
GetState_ComponentKind
GetState_ConfiguratorName
GetState_CurrentPartID
GetState_DatabaseLibraryKeys
GetState_DatabaseLibraryName
GetState_DatabaseTableName
GetState_DesignatorLocked
GetState_DisplayFieldNames
GetState_DisplayMode
GetState_DisplayModeCount
GetState_IsMirrored
GetState_LibraryPath
GetState_LibReference
GetState_Orientation
GetState_OverideColors
GetState_PartCountNoPart0
GetState_PartIdLocked
GetState_PinColor
GetState_PinsMoveable
GetState_SchComment
GetState_SchDesignator
GetState_SheetPartFileName
GetState_ShowHiddenFields
GetState_ShowHiddenPins
GetState_SourceLibraryName
GetState_TargetFileName
GetState_UniqueId
SetState_AliasAsText
SetState_AliasAt
SetState_ComponentDescription
SetState_ComponentKind
SetState_CurrentPartID
SetState_DesignatorLocked
SetState_DisplayFieldNames
SetState_DisplayMode
SetState_DisplayModeCount_Check
SetState_FilePosition
SetState_IsMirrored
SetState_LibraryPath
SetState_LibReference
SetState_Orientation
SetState_OverideColors
SetState_PartCountNoPart0
SetState_PartIdLocked
SetState_PinColor
SetState_PinsMoveable
SetState_SheetPartFileName
SetState_ShowHiddenFields
SetState_ShowHiddenPins
SetState_SourceLibraryName
SetState_TargetFileName
SetState_UniqueId
AddDisplayMode
AddPart
AddSchImplementation
Alias_Add
Alias_Clear
Alias_Delete
Alias_Remove
DeleteDisplayMode
DeletePart
FullPartDesignator
InLibrary
InSheet
IsIntegratedComponent
IsMultiPartComponent
RemoveSchImplementation
UpdatePrimitivesAccessibility
ISch_Component properties
Alias
AliasAsText
AliasCount
Comment
ComponentDescription
ComponentKind
ConfiguratorName
CurrentPartID
DatabaseLibraryName
DatabaseTableName
Designator
DesignatorLocked
DisplayFieldNames
DisplayMode
DisplayModeCount
IsMirrored
LibraryPath
LibReference
Orientation
OverideColors
PartCount
PartIdLocked
PinColor
PinsMoveable
SheetPartFileName
ShowHiddenFields
ShowHiddenPins
SourceLibraryName
TargetFileName
UniqueId

See also

Methods

AddSchImplementation method

(ISch_Component interface)
Syntax
Function AddSchImplementation : ISch_Implementation;
Description
Each schematic component can have models from one or more domains. A schematic component can also have multiple models per domain, one of which will be the current model for that domain.
A model represents all the information needed for a component in a given domain, while a datafile entity (or link) is the only information which is in an external file.

The models of a component are represented by the ISch_Implementation interface.
The mapping of pins of a component and the nodes/ports/pads of a model are represented by the ISch_MapDefiner interfaces.
The link between a model and its external data file links are represented by the ISch_DataFileLink interfaces.
Example
Implementation := Comp.AddSchImplementation;
See also
ISch_Component interface
ISch_Implementation interface
ISch_DataFileLink interface
ISch_MapDefiner interface

AddDisplayMode method

(ISch_Component interface)
Syntax
Procedure AddDisplayMode;
Description
The AddDisplayMode procedure adds a graphical representation (mode) for the current component. Up to 255 alternative modes can be created.
Example
Comp.AddDisplayMode;
See also
ISch_Component interface

AddPart method

(ISch_Component interface)
Syntax
Procedure AddPart;
Description
Example
See also
ISch_Component interface

Alias_Add method

(ISch_Component interface)
Syntax
Procedure Alias_Add (S : WideString);
Description
Example
See also
ISch_Component interface

Alias_Clear method

(ISch_Component interface)
Syntax
Procedure Alias_Clear;
Description
Example
See also
ISch_Component interface

Alias_Delete method

(ISch_Component interface)
Syntax
Procedure Alias_Delete(i : Integer);
Description
Example
See also
ISch_Component interface

Alias_Remove method

(ISch_Component interface)
Syntax
Procedure Alias_Remove(S : WideString);
Description
Example
See also
ISch_Component interface

DeleteDisplayMode method

(ISch_Component interface)
Syntax
Procedure DeleteDisplayMode(AMode : TDisplayMode);
Description
This DeleteDisplayMode removes a display mode (graphical representation) from the component.
Example
Component.DeleteDisplayMode(3);
See also
TDisplayMode type from RT_Workspace unit. Byte type.
ISch_Component interface

DeletePart method

(ISch_Component interface)
Syntax
Procedure DeletePart (APartId : Integer);
Description
Example
See also
ISch_Component interface

FullPartDesignator method

(ISch_Component interface)
Syntax
Function FullPartDesignator(APartId : Integer) : WideString;
Description
Example
See also
ISch_Component interface

GetState_AliasAsText method

(ISch_Component interface)
Syntax
Function GetState_AliasAsText : WideString;
Description
Example
See also
ISch_Component interface

GetState_AliasAt method

(ISch_Component interface)
Syntax
Function GetState_AliasAt(i : Integer) : WideString;
Description
Example
See also
ISch_Component interface

GetState_AliasCount method

(ISch_Component interface)
Syntax
Function GetState_AliasCount : Integer;
Description
Example
See also
ISch_Component interface

GetState_ComponentDescription method

(ISch_Component interface)
Syntax
Function GetState_ComponentDescription : WideString;
Description
The GetState_ComponentDescription function returns the description string for this component. This string is normally used to describe what this component is for.
Example
Desc := Component.GetState_ComponentDescription;
See also
ISch_Component interface

GetState_ComponentKind method

(ISch_Component interface)
Syntax
Function GetState_ComponentKind : TComponentKind;
Description
The GetState_ComponentKind function returns a value of TComponentKind for the component.

  • eComponentKind_Standard: These components possess standard electrical properties, are always synchronized and are the type most commonly used on a schematic sheet.
  • eComponentKind_Mechanical: These components do not have electrical properties and will appear in the BOM. They are synchronized if the same components exist on both the Schematic and PCB documents. An example is a heatsink.
  • eComponentKind_Graphical: These components are not used during synchronization or checked for electrical errors. These components are used, for example, when adding company logos to documents.
  • eComponentKind_NetTie_BOM: These components short two or more different nets and these components will appear in the BOM and are maintained during synchronization.
  • eComponentKind_NetTie_NoBOM: These components short two or more different nets and these components will NOT appear in the BOM and are maintained during synchronization.
  • eComponentKind_Standard_NoBOM: These components possess standard electrical properties, and are synchronized BUT are not included in any BOM file produced from the file.

Example
Component.GetState_ComponentKind;
See also
TComponentKind from RT_Workspace unit.
ISch_Component interface

GetState_CurrentPartID method

(ISch_Component interface)
Syntax
Function GetState_CurrentPartID : Integer;
Description
Example
See also
ISch_Component interface

GetState_DesignatorLocked method

(ISch_Component interface)
Syntax
Function GetState_DesignatorLocked : Boolean;
Description
Example
See also
ISch_Component interface

GetState_DisplayFieldNames method

(ISch_Component interface)
Syntax
Function GetState_DisplayFieldNames : Boolean;
Description
Example
See also
ISch_Component interface

GetState_DisplayMode method

(ISch_Component interface)
Syntax
Function GetState_DisplayMode : TDisplayMode;
Description
The GetState_DisplayMode function returns the TDisplayMode value for this component. This TDisplayMode is a byte type from RT_Workspace unit.
Example
Mode := Comp.GetState_DisplayMode;
See also
ISch_Component interface

GetState_DisplayModeCount method

(ISch_Component interface)
Syntax
Function GetState_DisplayModeCount : Integer;
Description
This GetState_DisplayModeCount procedure returns the number of display modes or graphical representations for this component. There can be up to 255 modes.
Example
Count := Comp.GetState_DisplayModeCount;
See also
ISch_Component interface

GetState_IsMirrored method

(ISch_Component interface)
Syntax
Function GetState_IsMirrored : Boolean;
Description
The GetState_IsMirrored function determines whether the component is mirrored along the x-axis or not.
Example
Mirrored := Comp.GetState_IsMirrored;
See also
ISch_Component interface

GetState_LibraryPath method

(ISch_Component interface)
Syntax
Function GetState_LibraryPath : WideString;
Description
Example
See also
ISch_Component interface

GetState_LibReference method

(ISch_Component interface)
Syntax
Function GetState_LibReference : WideString;
Description
Example
See also
ISch_Component interface

GetState_Orientation method

(ISch_Component interface)
Syntax
Function GetState_Orientation : TRotationBy90;
Description
The Orientation property determines the orientation of the component on the schematic sheet in increments of 0,90,180 and 270 degrees only.
This method obtains the orientation value of the component and is used in the Orientation property.
Example
See also
ISch_Component interface
TRotationBy90 type

GetState_OverideColors method

(ISch_Component interface)
Syntax
Function GetState_OverideColors : Boolean;
Description
Example
See also
ISch_Component interface

GetState_PartCountNoPart0 method

(ISch_Component interface)
Syntax
Function GetState_PartCountNoPart0 : Integer;
Description
A component can consist of more than one part, for example a 74LS00 contains four parts. This property returns the number of parts for the component.
The function returns you the number of parts for a component and is used in the PartCountNoPart0 property.
Note
Each component also includes a non-graphical part, Part Zero. Part Zero is used for pins that are to be included in all parts of a multi-part component, for example power pins.
Example
See also
ISch_Component interface

GetState_PartIdLocked method

(ISch_Component interface)
Syntax
Function GetState_PartIdLocked : Boolean;
Description
Example
See also
ISch_Component interface

GetState_PinColor method

(ISch_Component interface)
Syntax
Function GetState_PinColor : TColor;
Description
Example
See also
ISch_Component interface

GetState_PinsMoveable method

(ISch_Component interface)
Syntax
Function GetState_PinsMoveable : Boolean;
Description
Example
See also
ISch_Component interface

GetState_SchComment method

(ISch_Component interface)
Syntax
Function GetState_SchComment : ISch_Parameter;
Description
The Comment property determines the comment object associated with the component object. The Component Properties dialog for this component has a Comment field. The Parameter object has a Name and Value fields and this Name field will normally have ‘Comment’ string and a Value string.
Example
Comp.GetState_SchComment := ‘LM833M’;
See also
ISch_Parameter interface
ISch_Component interface

GetState_SchDesignator method

(ISch_Component interface)
Syntax
Function GetState_SchDesignator : ISch_Designator;
Description
Example
See also
ISch_Component interface

GetState_SheetPartFileName method

(ISch_Component interface)
Syntax
Function GetState_SheetPartFileName : WideString;
Description
Example
See also
ISch_Component interface

GetState_ShowHiddenFields method

(ISch_Component interface)
Syntax
Function GetState_ShowHiddenFields : Boolean;
Description
Example
See also
ISch_Component interface

GetState_ShowHiddenPins method

(ISch_Component interface)
Syntax
Function GetState_ShowHiddenPins : Boolean;
Description
This property determines whether the hidden pins of a component can be hidden or not. Power pins are often defined as hidden. This method gets the boolean value whether the hidden pins are displayed or not and is used in the ShowHiddenPins property.
Example
See also
ISch_Component interface

GetState_SourceLibraryName method

(ISch_Component interface)
Syntax
Function GetState_SourceLibraryName : WideString;
Description
Example
See also
ISch_Component interface

GetState_TargetFileName method

(ISch_Component interface)
Syntax
Function GetState_TargetFileName : WideString;
Description
Example
See also
ISch_Component interface

GetState_UniqueId method

(ISch_Component interface)
Syntax
Function GetState_UniqueId : WideString;
Description
Example
See also
ISch_Component interface

InLibrary method

(ISch_Component interface)
Syntax
Function InLibrary : Boolean;
Description
Example
See also
ISch_Component interface

InSheet method

(ISch_Component interface)
Syntax
Function InSheet : Boolean;
Description
Example
See also
ISch_Component interface

IsIntegratedComponent method

(ISch_Component interface)
Syntax
Function IsIntegratedComponent : Boolean;
Description
Example
See also
ISch_Component interface

IsMultiPartComponent method

(ISch_Component interface)
Syntax
Function IsMultiPartComponent : Boolean;
Description
Example
See also
ISch_Component interface

RemoveSchImplementation method

(ISch_Component interface)
Syntax
Procedure RemoveSchImplementation(AnImplementation : ISch_Implementation);
Description
Example
See also
ISch_Component interface

SetState_AliasAsText method

(ISch_Component interface)
Syntax
Procedure SetState_AliasAsText (AValue : WideString);
Description
Example
See also
ISch_Component interface

SetState_AliasAt method

(ISch_Component interface)
Syntax
Procedure SetState_AliasAt (i : Integer; AValue : WideString);
Description
Example
See also
ISch_Component interface

SetState_ComponentDescription method

(ISch_Component interface)
Syntax
Procedure SetState_ComponentDescription (AValue : WideString);
Description
Example
See also
ISch_Component interface

SetState_ComponentKind method

(ISch_Component interface)
Syntax
Procedure SetState_ComponentKind (AValue : TComponentKind);
Description
The SetState_ComponentKind function sets the component of a TComponentKind value.

  • eComponentKind_Standard: These components possess standard electrical properties, are always synchronized and are the type most commonly used on a schematic sheet.
  • eComponentKind_Mechanical: These components do not have electrical properties and will appear in the BOM. They are synchronized if the same components exist on both the Schematic and PCB documents. An example is a heatsink.
  • eComponentKind_Graphical: These components are not used during synchronization or checked for electrical errors. These components are used, for example, when adding company logos to documents.
  • eComponentKind_NetTie_BOM: These components short two or more different nets and these components will appear in the BOM and are maintained during synchronization.
  • eComponentKind_NetTie_NoBOM: These components short two or more different nets and these components will NOT appear in the BOM and are maintained during synchronization.
  • eComponentKind_Standard_NoBOM: These components possess standard electrical properties, and are synchronized BUT are not included in any BOM file produced from the file.

Example
Component.SetState_ComponentKind(eComponentKind_Standard);
See also
ISch_Component interface

SetState_CurrentPartID method

(ISch_Component interface)
Syntax
Procedure SetState_CurrentPartID (AValue : Integer);
Description
Example
See also
ISch_Component interface

SetState_DesignatorLocked method

(ISch_Component interface)
Syntax
Procedure SetState_DesignatorLocked (AValue : Boolean);
Description
Example
See also
ISch_Component interface

SetState_DisplayFieldNames method

(ISch_Component interface)
Syntax
Procedure SetState_DisplayFieldNames (AValue : Boolean);
Description
Example
See also
ISch_Component interface

SetState_DisplayMode method

(ISch_Component interface)
Syntax
Procedure SetState_DisplayMode (AValue : TDisplayMode);
Description
Example
See also
ISch_Component interface

SetState_DisplayModeCount_Check method

(ISch_Component interface)
Syntax
Procedure SetState_DisplayModeCount_Check (AValue : Integer);
Description
Example
See also
ISch_Component interface

SetState_FilePosition method

(ISch_Component interface)
Syntax
Procedure SetState_FilePosition (AValue : Integer);
Description
Example
See also
ISch_Component interface

SetState_IsMirrored method

(ISch_Component interface)
Syntax
Procedure SetState_IsMirrored (AValue : Boolean);
Description
The SetState_IsMirrored function sets the component’s mirror property along the x-axis.
Example
Comp.SetState_IsMirrored(True);
See also
ISch_Component interface

SetState_LibraryPath method

(ISch_Component interface)
Syntax
Procedure SetState_LibraryPath (AValue : WideString);
Description
Example
See also
ISch_Component interface

SetState_LibReference method

(ISch_Component interface)
Syntax
Procedure SetState_LibReference (AValue : WideString);
Description
Example
See also
ISch_Component interface

SetState_Orientation method

(ISch_Component interface)
Syntax
Procedure SetState_Orientation (AValue : TRotationBy90);
Description
The Orientation property determines the orientation of the component on the schematic sheet in increments of 0,90,180 and 270 degrees only. This method sets the orientation value of the component and is used in the Orientation property.
Example
Component.SetState_Orientation(eRotate180);
See also
TRotationBy90 type
ISch_Component interface

SetState_OverideColors method

(ISch_Component interface)
Syntax
Procedure SetState_OverideColors (AValue : Boolean);
Description
The SetState_OverideColors procedure sets the local colors for the component. This component's fill, line and pin colors are overridden with the colors from the Fill, Lines and Pins color boxes respectively.
Note that the OverideColors property/method has a single 'r' character in 'Override', whereas the OverrideDisplayString property that applies to Labels, Ports etc, uses 'rr' characters.
Example
Comp.SetState_OverideColors(True);
See also
ISch_Component interface

SetState_PartCountNoPart0 method

(ISch_Component interface)
Syntax
Procedure SetState_PartCountNoPart0 (AValue : Integer);
Description
A component can consist of more than one part, for example a 74LS00 contains four parts. This property returns the number of parts for the component.
The function sets the number of parts for a component and is used in the PartCountNoPart0 property.
Note
Each component also includes a non-graphical part, Part Zero. Part Zero is used for pins that are to be included in all parts of a multi-part component, for example power pins.
Example
See also
ISch_Component interface

SetState_PartIdLocked method

(ISch_Component interface)
Syntax
Procedure SetState_PartIdLocked (AValue : Boolean);
Description
Example
See also
ISch_Component interface

SetState_PinColor method

(ISch_Component interface)
Syntax
Procedure SetState_PinColor (AValue : TColor);
Description
Example
See also
ISch_Component interface

SetState_PinsMoveable method

(ISch_Component interface)
Syntax
Procedure SetState_PinsMoveable (AValue : Boolean);
Description
Example
See also
ISch_Component interface

SetState_SheetPartFileName method

(ISch_Component interface)
Syntax
Procedure SetState_SheetPartFileName (AValue : WideString);
Description
Example
See also
ISch_Component interface

SetState_ShowHiddenFields method

(ISch_Component interface)
Syntax
Procedure SetState_ShowHiddenFields (AValue : Boolean);
Description
The SetState_ShowHiddenFields procedure determines the visibility of the text fields associated with the component, such as its name and filename. If the Value is true, the hidden fields of the comonent will be displayed on the schematic sheet. If the value is False, the hidden text fields are not shown on the schematic.
Example
Comp.SetState_ShowHiddenFields(True); // display the hidden text fields.
See also
ISch_Component interface

SetState_ShowHiddenPins method

(ISch_Component interface)
Syntax
Procedure SetState_ShowHiddenPins (AValue : Boolean);
Description
This property determines whether the hidden pins of a component can be hidden or not. Power pins are often defined as hidden. This method sets the boolean value whether the hidden pins are displayed or not and is used in the ShowHiddenPins property.
Example
Comp.SetState_ShowHiddenPins(True); // show hidden pins of this component.
See also
ISch_Component interface

SetState_SourceLibraryName method

(ISch_Component interface)
Syntax
Procedure SetState_SourceLibraryName (AValue : WideString);
Description
Example
See also
ISch_Component interface

SetState_TargetFileName method

(ISch_Component interface)
Syntax
Procedure SetState_TargetFileName (AValue : WideString);
Description
Example
See also
ISch_Component interface

SetState_UniqueId method

(ISch_Component interface)
Syntax
Procedure SetState_UniqueId (AValue : WideString);
Description
The SetState_UniqueID procedure sets the new ID for the component. All parameters, sheet symbols, ports, pins, components, openbus links, openbus ports and openbus components have Unique IDs. Unique IDs are used to maintain design synchronization in design projects.

The Unique ID (UID) is an system generated value that uniquely identifies this current component. It is used for linking to a PCB document and for project management. Enter a new UID value or click the Reset button to generate a new UID for this design object from the Change Properties dialog. You can also globally reset UIDs of components and sheet symbols from the Schematic Editor’s Tools » Convert » Reset Component Unique IDs menu.
Example

UID := WSM.DM_GenerateUniqueID; // interface and method from Workspace Manager API.
Component.SetState_UniqueID(UID);

See also
ISch_Component interface

Properties

Alias property

(ISch_Component interface)
Syntax
Property Alias[i : Integer] : WideString Read GetState_AliasAt Write SetState_AliasAt;
Description
The indexed property returns an alias string. A component can have multiple aliases because a component name can be referred to by multiple names. For example a SN7432 is also SN74LS32 or SN74S32.
Notes
Use the AliasCount property to obtain the number of aliases before going through one by one.
Example
See also
ISch_Component interface

AliasAsText property

(ISch_Component interface)
Syntax
Property AliasAsText : WideString Read GetState_AliasAsText Write SetState_AliasAsText;
Description
Example
See also
ISch_Component interface

AliasCount property

(ISch_Component interface)
Syntax
Property AliasCount : Integer Read GetState_AliasCount;
Description
Notes
Use the AliasCount to obtain the count before going through each indexed Alias property one by one.
Example
See also
ISch_Component interface

Comment property

(ISch_Component interface)
Syntax
Property Comment : ISch_Parameter Read GetState_SchComment;
Description
The Comment property determines the comment object associated with the component object. The Component Properties dialog for this component has a Comment field. The Parameter object has a Name and Value fields and this Name field will normally have ‘Comment’ string and a Value string.
Example
Comp.Comment.Name := ‘LM833M’;
See also
ISch_Parameter interface;
ISch_Component interface

ComponentDescription property

(ISch_Component interface)
Syntax
Property ComponentDescription : WideString Read GetState_ComponentDescription Write SetState_ComponentDescription;
Description
The ComponentDescription property determines the description string for this component. Normally this string contains text on what this component is. This property is supported by the GetState_ComponentDescription and SetState_ComponentDescription methods.
Example
Comp.ComponentDescription := ‘Fast Settling Dual Operational Amplifier’;
See also
ISch_Component interface

ComponentKind property

(ISch_Component interface)
Syntax
Property ComponentKind : TComponentKind Read GetState_ComponentKind Write SetState_ComponentKind;
Description
The ComponentKind property deteremines the component’s type of TComponentKind type. This property is supported by the GetState_ComponentKind and Setstate_Component kind methods.

  • eComponentKind_Standard: These components possess standard electrical properties, are always synchronized and are the type most commonly used on a schematic sheet.
  • eComponentKind_Mechanical: These components do not have electrical properties and will appear in the BOM. They are synchronized if the same components exist on both the Schematic and PCB documents. An example is a heatsink.
  • eComponentKind_Graphical: These components are not used during synchronization or checked for electrical errors. These components are used, for example, when adding company logos to documents.
  • eComponentKind_NetTie_BOM: These components short two or more different nets and these components will appear in the BOM and are maintained during synchronization.
  • eComponentKind_NetTie_NoBOM: These components short two or more different nets and these components will NOT appear in the BOM and are maintained during synchronization.
  • eComponentKind_Standard_NoBOM: These components possess standard electrical properties, and are synchronized BUT are not included in any BOM file produced from the file.

Example
Component.ComponentKind := eComponentKind_NetTie_BOM;
See also
TComponentKind from RT_Workspace unit.
ISch_Component interface

CurrentPartID property

(ISch_Component interface)
Syntax
Property CurrentPartID : Integer Read GetState_CurrentPartID Write SetState_CurrentPartID;
Description
Example
See also
ISch_Component interface

Designator property

(ISch_Component interface)
Syntax
Property Designator : ISch_Designator Read GetState_SchDesignator;
Description
Example
See also
ISch_Designator interface.
ISch_Component interface

DisplayFieldNames property

(ISch_Component interface)
Syntax
Property DisplayFieldNames : Boolean Read GetState_DisplayFieldNames Write SetState_DisplayFieldNames;
Description
Example
See also
ISch_Component interface

DesignatorLocked property

(ISch_Component interface)
Syntax
Property DesignatorLocked : Boolean Read GetState_DesignatorLocked Write SetState_DesignatorLocked;
Description
Example
See also
ISch_Component interface

DisplayMode property

(ISch_Component interface)
Syntax
Property DisplayMode : TDisplayMode Read GetState_DisplayMode Write SetState_DisplayMode;
Description
Example
See also
ISch_Component interface

DisplayModeCount property

(ISch_Component interface)
Syntax
Property DisplayModeCount : Integer Read GetState_DisplayModeCount Write SetState_DisplayModeCount_Check;
Description
The property can return up to 255 display modes for the same component. Modes are added or edited in the Schematic Library Editor.
This property is supported by the GetState_DisplayModeCount and SetState_DisplayModeCount_Check methods.
Example
See also
ISch_Component interface

IsMirrored property

(ISch_Component interface)
Syntax
Property IsMirrored : Boolean Read GetState_IsMirrored Write SetState_IsMirrored;
Description
The IsMirrored property determines whether the component is mirrored along the x-axis. This property is supported by the GetState_IsMirrored and SetState_IsMirrored methods.
Example
Component.IsMirrored := False;
See also
ISch_Component interface

LibraryPath property

(ISch_Component interface)
Syntax
Property LibraryPath : WideString Read GetState_LibraryPath Write SetState_LibraryPath;
Description
Example
See also
ISch_Component interface

LibReference property

(ISch_Component interface)
Syntax
Property LibReference : WideString Read GetState_LibReference Write SetState_LibReference;
Description
Example
See also
ISch_Component interface

Orientation property

(ISch_Component interface)
Syntax
Property Orientation : TRotationBy90 Read GetState_Orientation Write SetState_Orientation;
Description
This property determines the orientation of the component on the schematic sheet in increments of 0,90,180 and 270 degrees only. This property is supported by the GetState_Orientation and SetState_Orientation methods.
Example
Component.Orientation := eRotate180;
See also
ISch_Component interface
TRotationBy90 type

OverideColors property

(ISch_Component interface)
Syntax
Property OverideColors : Boolean Read GetState_OverideColors Write SetState_OverideColors;
Description
Example
See also
ISch_Component interface

PartCount property

(ISch_Component interface)
Syntax
Property PartCount : Integer Read GetState_PartCountNoPart0 Write SetState_PartCountNoPart0;
Description
A component can consist of more than one part, for example a 74LS00 contains four parts. This property returns the number of parts for the component and is supported by the GetState_PartCountNoPart0 and SetState_PartCountNoPart0 methods.
Note
Each component also includes a non-graphical part, Part Zero. Part Zero is used for pins that are to be included in all parts of a multi-part component, for example power pins.
Example
See also
ISch_Component interface

PinsMoveable property

(ISch_Component interface)
Syntax
Property PinsMoveable : Boolean Read GetState_PinsMoveable Write SetState_PinsMoveable;
Description
Example
See also
ISch_Component interface

PinColor property

(ISch_Component interface)
Syntax
Property PinColor : TColor Read GetState_PinColor Write SetState_PinColor;
Description
Example
See also
ISch_Component interface

PartIdLocked property

(ISch_Component interface)
Syntax
Property PartIdLocked : Boolean Read GetState_PartIdLocked Write SetState_PartIdLocked;
Description
Example
See also
ISch_Component interface

SheetPartFileName property

(ISch_Component interface)
Syntax
Property SheetPartFileName : WideString Read GetState_SheetPartFileName Write SetState_SheetPartFileName;
Description
Example
See also
ISch_Component interface

ShowHiddenFields property

(ISch_Component interface)
Syntax
Property ShowHiddenFields : Boolean Read GetState_ShowHiddenFields Write SetState_ShowHiddenFields;
Description
The ShowHiddenFields property determines the visibility of the text fields associated with the component, such as its name. If the Value is true, the hidden fields of the component will be displayed on the schematic sheet. If the value is False, the hidden text fields are not shown on the schematic.
Example
Comp.ShowHiddenFields := True;
See also
ISch_Component interface

ShowHiddenPins property

(ISch_Component interface)
Syntax
Property ShowHiddenPins : Boolean Read GetState_ShowHiddenPins Write SetState_ShowHiddenPins;
Description
This property determines whether the hidden pins of a component can be hidden or not. Power pins are often defined as hidden. This property is supported by the GetState_ShowHiddenPins and SetState_ShowHiddenPins methods.
Example
Comp.ShowHiddenPins := True;
See also
ISch_Component interface

SourceLibraryName property

(ISch_Component interface)
Syntax
Property SourceLibraryName : WideString Read GetState_SourceLibraryName Write SetState_SourceLibraryName;
Description
Example
See also
ISch_Component interface

TargetFileName property

(ISch_Component interface)
Syntax
Property TargetFileName : WideString Read GetState_TargetFileName Write SetState_TargetFileName;
Description
Example
See also
ISch_Component interface

UniqueId property

(ISch_Component interface)
Syntax
Property UniqueId : WideString Read GetState_UniqueId Write SetState_UniqueId;
Description
The UniqueID property sets the new ID for the component. All parameters, sheet symbols, ports, pins, components, openbus links, openbus ports and openbus components have Unique IDs. Unique IDs are used to maintain design synchronization in design projects.

The Unique ID (UID) is an system generated value that uniquely identifies this current component. It is used for linking to a PCB document and for project management. Enter a new UID value or click the Reset button to generate a new UID for this design object from the Change Properties dialog. You can also globally reset UIDs of components and sheet symbols from the Schematic Editor’s Tools » Convert » Reset Component Unique IDs menu.
Example

UID := WSM.DM_GenerateUniqueID; // interface and method from Workspace Manager API.
Component.UniqueID(UID);

See also
ISch_Component interface

ISch_ConnectionLine Interface

Overview
A connection line represents a line that has corner properties as well as width and style properties between two nodes on a schematic document.
Notes
The ISch_ConnectionLine interface hierarchy is as follows:
ISch_GraphicalObject
    ISch_Line
        ISch_BusEntry
            ISch_ConnectionLine

ISch_ConnectionLine methods
GetState_IsInferred
SetState_IsInferred
ISch_ConnectionLine properties
IsInferred

See also

Methods

UpdatePrimitivesAccessibility method

(ISch_Component interface)
Syntax
Procedure UpdatePrimitivesAccessibility;
Description
When the connection lines have been modified, invoke the UpdatePrimitivesAccessibility to ensure the primitives associated with the connection lines have been refreshed.
Example
See also
ISch_Component interface

GetState_IsInferred method

(ISch_ConnectionLine interface)
Syntax
Function GetState_IsInferred : Boolean;
Description
An inferred property indicates that a connection between documents has been detected by the Schematic Navigation system after the project has been compiled.

An inferred property denotes whether the object is an inferred object with respect to connective objects. Bus and Sheet Symbols can be defined in ranges using the NetLabel [] and Repeat statements respectively and once the project has been compiled, inferred objects created in memory for navigation/connective purposes. For example, a Bus with a range of A[0..4] ends up with five wires with A0...A5 net labels (only in memory). This property is useful for multi – channel projects and for sheets that have Bus objects.

This method gets the IsInferred state and is used in the IsInferred property.
Example
See also
ISch_ConnectionLine interface

SetState_IsInferred method

(ISch_ConnectionLine interface)
Syntax
Procedure SetState_IsInferred(B : Boolean);
Description
An inferred property indicates that a connection between documents has been detected by the Schematic Navigation system after the project has been compiled.

An inferred property denotes whether the object is an inferred object with respect to connective objects. Bus and Sheet Symbols can be defined in ranges using the NetLabel [] and Repeat statements respectively and once the project has been compiled, inferred objects created in memory for navigation/connective purposes. For example, a Bus with a range of A[0..4] ends up with five wires with A0...A5 net labels (only in memory). This property is useful for multi – channel projects and for sheets that have Bus objects.

This method sets the IsInferred state and is used in the IsInferred property.
Example
See also
ISch_ConnectionLine interface

Properties

IsInferred property

(ISch_ConnectionLine interface)
Syntax
Property IsInferred : Boolean Read GetState_IsInferred Write SetState_IsInferred;
Description
An inferred property indicates that a connection between documents has been detected by the Schematic Navigation system after the project has been compiled.

An inferred property denotes whether the object is an inferred object with respect to connective objects. Bus and Sheet Symbols can be defined in ranges using the NetLabel [] and Repeat statements respectively and once the project has been compiled, inferred objects created in memory for navigation/connective purposes. For example, a Bus with a range of A[0..4] ends up with five wires with A0...A5 net labels (only in memory). This property is useful for multi – channel projects and for sheets that have Bus objects.

This property is supported by the GetState_IsInferred and SetState_IsInferred methods.
Example
See also
ISch_ConnectionLine interface

ISch_CrossSheetConnector Interface

Overview
Cross sheet connector objects can be used to link a net from a sheet to other sheets within a project. This method defines global connections between sheets within a project.
Notes
The ISch_CrossSheetConnector interface hierarchy is as follows:
ISch_GraphicalObject
    ISch_Label
        ISch_PowerObject
            ISch_CrossSheetConnector

ISch_CrossSheetConnector methods
GetCrossSheetConnectorStyle
SetCrossSheetConnectorStyle
ISch_CrossSheetConnector properties
CrossSheetStyle

See also
ISch_GraphicalObject interface
ISch_Label interface
ISch_PowerObject interface
ISch_CrossSheetConnector interface

Methods

GetCrossSheetConnectorStyle method

(ISch_CrossSheetConnector interface)
Syntax
Function GetCrossSheetConnectorStyle : TCrossSheetConnectorStyle;
Description
The GetCrossSheetConnectorStyle function determines the style or the alignment of the Off Sheet Connector object.
Example

// Port alignment is determined by the CrossConnector's Style.
If CrossConn.GetCrossSheetStyle = eCrossSheetRight Then
    Port.Alignment := eRightAlign
Else
    Port.Alignment := eLeftAlign;

See also
TCrossSheetConnectorStyle type
ISch_CrossSheetConnector interface

SetCrossSheetConnectorStyle method

(ISch_CrossSheetConnector interface)
Syntax
Procedure SetCrossSheetConnectorStyle (Const Value : TCrossSheetConnectorStyle);
Description
The SetCrossSheetConnectorStyle function sets the style or the alignment of the off sheet connector object.
Example

// Port alignment is determined by the CrossConnector's Style.
If Port.Alignment := eRightAlign Then
    CrossConn.CrossSheetStyle := eCrossSheetRight
Else
    CrossConn.CrossSheetStyle := eCrossSheetLeft

See also
TCrossSheetConnectorStyle type
ISch_CrossSheetConnector interface

Properties

CrossSheetStyle property

(ISch_CrossSheetConnector interface)
Syntax
Property CrossSheetStyle : TCrossSheetConnectorStyle Read GetCrossSheetConnectorStyle Write SetCrossSheetConnectorStyle;
Description
The CrossSheetStyle property represents the style or the alignment of the cross sheet object. This property is supported by the GetCrossSheetConnectorStyle and SetCrossSheetConnectorStyle methods.
Example

// Port alignment is determined by the CrossConnector's Style.
If CrossConn.CrossSheetStyle = eCrossSheetRight Then
    Port.Alignment := eRightAlign
Else
    Port.Alignment := eLeftAlign;

See also
TCrossSheetConnectorStyle type
ISch_CrossSheetConnector interface

ISch_Designator Interface

Overview
The ISch_Designator interface represents a designator object which is part of the component object that identifies it as part of a net. Refer to the ISch_Parameter interface for details.
Notes
The ISch_Designator interface hierarchy is as follows:
ISch_GraphicalObject
    ISch_Label
        ISch_ComplexText
            ISch_Parameter
                ISch_Designator

ISch_Designator methods ISch_Designator properties

See also
ISch_GraphicalObject interface
ISch_Label interface
ISch_ComplexText interface
ISch_Parameter interface
ISch_Designator interface

ISch_Directive Interface

Overview
An ISch_Directive interface represents an object that stores a text string. It is an ancestor interface for the ISch_ErrorMarker interface. Design constraints (rules) can be defined prior to PCB layout, by adding parameters that are configured as design rule directives to the schematic source document(s).
Notes
The ISch_Directive interface hierarchy is as follows:
ISch_GraphicalObject
    ISch_Directive

ISch_Directive methods ISch_Directive properties
Text

See also
ISchGraphicalObject interface

Properties

Text property

(ISch_Directive interface)
Syntax
Property Text : WideString Read GetState_Text Write SetState_Text;
Description
The Text property represents the text information for the directive objects and the error marker objects.
Example
Directive.Text := ‘Schematic Directive’;
See also
ISch_Directive interface
ISch_ErrorMarker interface

ISch_Ellipse

Overview
An ellipse is a drawing object which is filled or unfilled graphic elements on a schematic sheet. Refer to the ISch_Circle interface for details.
Notes
The ISch_Ellipse interface hierarchy is as follows:
ISch_GraphicalObject
                ISch_Circle
                                ISch_Ellipse

ISch_Ellipse methods
GetState_SecondaryRadius
SetState_SecondaryRadius
ISch_Ellipse properties
SecondaryRadius

Methods

GetState_SecondaryRadius method

(ISch_Ellipse interface)
Syntax
Function GetState_SecondaryRadius : TDistance;
Description
This function retrieves the secondary radius or the Y coordinate of the elliptical arc with a TDistance value.
Example

XRadius := Ellipse.Radius;
YRadius := Ellipse.SecondaryRadius;

See also
TDistance type
ISch_Circle interface

SetState_SecondaryRadius method

(ISch_Ellipse interface)
Syntax
Procedure SetState_SecondaryRadius(ARadius : TDistance);
Description
This function sets the secondary radius or the Y coordinate of the ellipse with a TDistance value.
Example

Ellipse.Radius          := 4000000
Ellipse.SecondaryRadius := 7000000;

See also
ISch_EllipticalArc interface

Properties

SecondaryRadius property

(ISch_Ellipse interface)
Syntax
Property SecondaryRadius : TDistance Read GetState_SecondaryRadius Write SetState_SecondaryRadius;
Description
The secondary radius property defines the second set of arcs the define the elliptical arc. The elliptical arc has two sets of arcs (four all together). The Radius property defines the first set of arcs that define the elliptical arc (inherited from the ISch_Arc interface). This property is supported by the GetState_SecondaryRadius and SetState_SecondaryRadius methods.
Example

XRadius := Ellipse.Radius;
YRadius := Ellipse.SecondaryRadius;

See also
TDistance type
ISch_Circle interface

ISch_EllipticalArc Interface

Overview
Elliptical arc objects are drawing objects which represent open circular or elliptical curves on a schematic sheet. Refer to the ISch_Arc interface for extra details.
Notes
The ISch_EllipticalArc interface hierarchy is as follows:
ISch_GraphicalObject
    ISch_Arc
        ISch_EllipticalArc

ISch_EllipticalArc methods
GetState_SecondaryRadius
SetState_SecondaryRadius
ISch_EllipticalArc properties
SecondaryRadius

See also
ISch_GraphicalObject interface
ISch_Arc interface

Methods

GetState_SecondaryRadius method

(ISch_EllipticalArc interface)
Syntax
Function GetState_SecondaryRadius : TDistance;
Description
This function retrieves the secondary radius or the Y coordinate of the elliptical arc with a TDistance value.
Example

XRadius := EllipticalArc.Radius;
YRadius := EllipticalArc.SecondaryRadius;

See also
TDistance type
ISch_EllipticalArc interface

SetState_SecondaryRadius method

(ISch_EllipticalArc interface)
Syntax
Procedure SetState_SecondaryRadius(ARadius : TDistance);
Description
This function sets the secondary radius or the Y coordinate of the elliptical arc with a TDistance value.
Example

EllipticalArc.Radius          := 4000000
EllipticalArc.SecondaryRadius := 7000000;

See also
TDistance type
ISch_EllipticalArc interface

Properties

SecondaryRadius property

(ISch_EllipticalArc interface)
Syntax
Property SecondaryRadius : TDistance Read GetState_SecondaryRadius Write SetState_SecondaryRadius;
Description
The secondary radius property defines the second set of arcs the define the elliptical arc. The elliptical arc has two sets of arcs (four all together). The Radius property defines the first set of arcs that define the elliptical arc (inherited from the ISch_Arc interface). This property is supported by the GetState_SecondaryRadius and SetState_SecondaryRadius methods.
Example

XRadius := EllipticalArc.Radius;
YRadius := EllipticalArc.SecondaryRadius;

See also
TDistance type
ISch_Arc interface
ISch_EllipticalArc interface

ISch_ErrorMarker Interface

Overview
Error Markers are placed on a schematic sheet at the site of each ERC violation by the Schematic Editor. Refer to the ISch_Directive and ISch_GraphicalObject interfaces for details.
Notes
The ISch_ErrorMarker interface hierarchy is as follows:
ISch_GraphicalObject
    ISch_Directive
        ISch_ErrorMarker
See also
ISch_GraphicalObject interface
ISch_Directive interface

ISch_HarnessConnector Interface

Overview
The ISch_HarnessConnector interface is used to represent a harness connector design obejct which is a member of the harness system.
Notes
The ISch_HarnessEntry interface hierarchy is as follows:
ISch_GraphicalObject
                ISch_RectangularGroup
                    ISch_HarnessConnector

ISch_HarnessConnector Methods
SetState_LineWidth
GetState_LineWidth
GetState_SchHarnessConnectorType
GetState_MasterEntryLocation
ISch_HarnessConnector Properties
LineWidth
HarnessConnectorType
MasterEntryLocation

Methods

SetState_LineWidth method

(ISch_HarnessConnector interface)
Syntax
Procedure SetState_LineWidth(Value : TSize);
Description
The SetState_LineWidth sets the line width of the harness connector which is based on one of the the TSize values.
Example
HarnessConn.SetState_LineWidth(eLarge);
See also
TSize type
ISch_HarnessConnector interface
ISch_HarnessEntry interface

GetState_LineWidth method

(ISch_HarnessConnector interface)
Syntax
Function GetState_LineWidth : TSize;
Description
The GetState_LineWidth gets the line width of the harness connector which is based on one of the the TSize values.
Example
LineWidth := HarnessConn.GetState_LineWidth;
See also
TSize type
ISch_HarnessConnector interface
ISch_HarnessEntry interface

GetState_SchHarnessConnectorType method

(ISch_HarnessConnector interface)
Syntax
Function GetState_SchHarnessConnectorType : ISch_HarnessConnectorType;
Description
The GetState_SchHarnessConnectorType function retrieves the harness connector type of the harness connector. The default type is ‘Harness’. This type value can be modified.
Example

Var
    HarnessConn : ISch_HarnessConnector;
    ConnType    : ISch_HarnessConnectorType;
    S           : String;
Begin
    // HarnessConn is a ISch_harnessConnector interface representing 
    // a harness connector design object.
    ConnType := HarnessConn. GetState_SchHarnessConnectorType;
 
    // Display the Text string for this harness connector.
    S := ConnType.Text;

See also
ISch_HarnessConnectorType interface
ISch_HarnessConnector interface
ISch_HarnessEntry interface

GetState_MasterEntryLocation method

(ISch_HarnessConnector interface)
Syntax
Function  GetState_MasterEntryLocation : TLocation;
Description
The GetState_MasterEntryLocation function returns the location of the master entry of the harness connector. The master entry represents the tip of the harness connector and the position of the tip is determined from the top side of the connector.
Example
Location := HarnessConn.GetState_MasterEntryLocation;
See also
TLocation type
ISch_HarnessConnectorType interface
ISch_HarnessConnector interface
ISch_HarnessEntry interface

Properties

LineWidth property

(ISch_HarnessConnector interface)
Syntax
Property LineWidth : TSize Read GetState_LineWidth Write SetState_LineWidth;
Description
The LineWidth property defines the line width of the harness connector which is based on one of the TSize values. . This property is supported by the GetState_LineWidth and SetState_LineWidth methods.
Example
HarnessConn.LineWidth := eLarge;
See also
TSize type
ISch_HarnessConnector interface

HarnessConnectorType property

(ISch_HarnessConnector interface)
Syntax
Property HarnessConnectorType: ISch_HarnessConnectorType Read GetState_SchHarnessConnectorType;
Description
The HarnessConnectorType property defines the harness connector type of the harness connector and returns the ISch_HarnessConnectorType interface. The default connector type is ‘Harness’. This property is supported by the GetState_HarnessConnectorType method.
Example

Var
    HarnessConn : ISch_HarnessConnector;
    ConnType    : ISch_HarnessConnectorType;
    S           : String;
Begin
    // HarnessConn is a ISch_HarnessConnector interface representing 
    // a harness connector design object.
    ConnType := HarnessConn.HarnessConnectorType;
 
    // Display the Text string for this harness connector.
    S := ConnType.Text;

See also
TSize type
ISch_HarnessConnectorType interface
ISch_HarnessConnector interface

MasterEntryLocation property

(ISch_HarnessConnector interface)
Syntax
Property MasterEntryLocation : TLocation Read GetState_MasterEntryLocation;
Description
The MasterEntryLocation property defines the location of the master entry of the harness connector. The master entry represents the tip of the harness connector and the position of the tip is determined from the top side of the connector.. This property is supported by the GetState_LineWidth method.
Example
 
See also
TSize type
ISch_HarnessConnector interface

ISch_HarnessConnectorType Interface

Overview
The ISchHarnessConnectorType interface represents the text object of the harness connector and defines the harness connector type. By Default the Type string is Harness.
Notes
The ISch_HarnessConnectorType interface hierarchy is as follows:
ISch_GraphicalObject
    ISch_Label
        ISch_ComplexT0065t
            ISch_HarnessConnectorType

ISch_HarnessConnector Methods ISch_HarnessConnector Properties

See also
ISch_HarnessConnector interface
ISch_HarnessEntry interface.

ISch_HarnessEntry Interface

Overview
The ISch_HarnessEntry interface is used to represent a harness entry which is a member of the harness system. Harness Entries are the graphical definition of a Signal Harness member. They are placed within a Harness Connector and they are the connection point through which actual nets, buses and Signal Harnesses are combined to form a higher level Signal Harness. Harness Entries along with Harness Connectors, Signal Harnesses and Harness Definition Files make up a complete Signal Harness.
Notes
The ISch_HarnessEntry interface hierarchy is as follows:
ISch_GraphicalObject
                ISch_HarnessEntry

ISch_HarnessEntry methods
SetState_Name
SetState_Side
SetState_DistanceFromTop
SetState_TextColor
SetState_OverrideDisplayString
GetState_Name
GetState_Side
GetState_DistanceFromTop
GetState_TextColor
GetState_OverrideDisplayString
GetState_SchOwnerHarnessConnector
ISch_HarnessEntry properties
IsVertical
Name
Side
DistanceFromTop
TextColor
OverrideDisplayString
OwnerHarnessConnector

Methods

GetState_Name method

(ISch_HarnessEntry interface)
Syntax
Function GetState_Name : WideString;
Description
The GetState_Name function returns the name of the harness entry. Normally the name is a number but can be alphanumeric.
Example
EntryName := HarnessEntry.GetStateName
See also
Name property.
ISch_HarnessEntry interface

GetState_Side method

(ISch_HarnessEntry interface)
Syntax
Function GetState_Side : TLeftRightSide;
Description
The GetState_Side function returns the orientation of the harness entry in respect to the associated harness connector as a TLeftRightSide type.
Example
Side := HarnessEntry.GetState_Side;
See also
TLeftRightSide type
ISch_HarnessEntry interface

GetState_DistanceFromTop method

(ISch_HarnessEntry interface)
Syntax
Function  GetState_DistanceFromTop : TCoord;
Description
The GetState_DistanceFromTop function returns the distance from this harness entry to the top edge of the harness connector in a value that’s dependent on the grid units. For example if the grid was in DXP Defaults (10 DXP units = 100 mils for example) and the Entry is 10 Units away from the Top part of the Harness Connector.
Example
Distance := HarnessEntry.GetState_DistanceFromTop;
See also
ISch_HarnessEntry interface

GetState_TextColor method

(ISch_HarnessEntry interface)
Syntax
Function  GetState_TextColor : TColor;
Description
The GetState_TextColor function returns the color of the text used for the Name of the Harness Entry.
Example
Color := HarnessEntry.GetState_TextColor;
See also
TColor type
ISch_HarnessEntry

GetState_OverrideDisplayString method

(ISch_HarnessEntry interface)
Syntax
Function  GetState_OverrideDisplayString : WideString;
Description
The GetState_OverrrideDisplayString function returns the override display string which overrides the Name string.
Example
DisplayString := HarnessEntry.GetState_OverrideDisplayString;
See also
ISch_HarnessEntry interface

GetState_SchOwnerHarnessConnector method

(ISch_HarnessEntry interface)
Syntax
Function  GetState_SchOwnerHarnessConnector : ISch_HarnessConnector;
Description
The GetState_SchOwnerHarnessConnector function returns the harness connector (ISch_HarnessConnector) that this harness entry is associated with.
Example
OwnerHarnessConnector := HarnessEntry.GetState_SchOwnerHarnessConnector;
See also
ISch_HarnessEntry interface

SetState_Name method

(ISch_HarnessEntry interface)
Syntax
Procedure SetState_Name(Value : WideString);
Description
The SetState_Name procedure sets the new name for the Harness Entry.
Example
HarnessEntry.SetState_Name(‘HarnessType2’);
See also
ISch_HarnessEntry interface

SetState_Side method

(ISch_HarnessEntry interface)
Syntax
Procedure SetState_Side(Value : TLeftRightSide);
Description
The SetState_Side procedure sets the orientation of the harness entry in respect to the associated harness connector.
Example
HarnessEntry.SetState_Side(eLeftSide);
See also
TLeftRightSide type.
ISch_HarnessEntry interface.

SetState_DistanceFromTop method

(ISch_HarnessEntry interface)
Syntax
Procedure SetState_DistanceFromTop(Value : TCoord);
Description
The SetState_DistanceFromTop function sets the distance from this harness entry to the top edge of the harness connector in a value that’s dependent on the grid units. For example if the grid was in DXP Defaults (10 DXP units = 100 mils for example) and the Entry is 10 Units away from the Top part of the Harness Connector then you would use the DxpToCoords function to translate the 10 grid units into a coordinate value.
Example
HarnessEntry.SetState_DistanceFromTop(DxpsToCoord(10));
See also
DXPsToCoord function
Measurement Conversion functions
ISch_HarnessEntry interface

SetState_TextColor method

(ISch_HarnessEntry interface)
Syntax
Procedure SetState_TextColor(Value : TColor);
Description
The SetState_TextColor procedure sets the color (a value of TColor type) for the Harness Entry’s Name string.
Notes
The TColor value specifies a 6 digit hexadecimal number of the $FFFFFF format.  For example the color blue would be RGB:0,0,255 and Hex:FF0000 therefore the converted decimal value would be 16711680.  The following formula may be used to calculate the required value, R+256*(G+(256*B)).
Example
HarnessEntry.SetState_TextColor(0); // sets the text color to black.
See also
TColor type
ISch_HarnessEntry interface

SetState_OverrideDisplayString method

(ISch_HarnessEntry interface)
Syntax
Procedure SetState_OverrideDisplayString(Value : WideString );
Description
The SetState_OverrideDisplayString procedure sets a new value consisting of alph-numeric characters for the Override Display string.
Example
HarnessEntry.SetState_OverrideDisplayString(‘New Override String’);
See also
ISch_HarnessEntry interface

Properties

IsVertical

(ISch_HarnessEntry interface)
Syntax
Function  IsVertical : Boolean;
Description
The IsVertical property defines the orientation of the harness entry in respect to the harness connector.
Example
If HarnessEntry.IsVertical Then ShowMessage(‘The hentry is vertical.’);
See also
ISch_HarnessEntry interface

Name

(ISch_HarnessEntry interface)
Syntax
Property Name : WideString Read GetState_Name Write SetState_Name;
Description
The Name property defines the name of the harness entry. Normally the name property is a number but can be alphanumeric... This property is supported by the GetState_Name and SetState_Name methods.
Example
HarnessEntry.Name := ‘HarnessType_2’;
See also
ISch_HarnessEntry interface

Side

(ISch_HarnessEntry interface)
Syntax
Property Side : TLeftRightSide Read GetState_Side Write SetState_Side;
Description
The Side property defines the orientation of the harness entry in respect to the associated harness connector. This property is supported by the GetState_Side and SetState_Side methods.
Example
HarnessEntry.Side := eLeftSide;
See also
ISch_HarnessEntry interface

DistanceFromTop

(ISch_HarnessEntry interface)
Syntax
Property DistanceFromTop : TCoord Read GetState_DistanceFromTop Write SetState_DistanceFromTop;
Description
The DistanceFromTop property defines the location of the harness entry in respect to the associated harness connector. This property is supported by the GetState_DistanceFromTop and SetState_DistanceFromTop methods.
Example
HarnessEntry.DistanceFromTop := DxpsToCoord(10);
See also
ISch_HarnessEntry interface

TextColor

(ISch_HarnessEntry interface)
Syntax
Property TextColor : TColor Read GetState_TextColor Write SetState_TextColor;
Description
The TextColor property defines the color (a value of TColor type) for the Harness Entry’s Name string. This property is supported by the GetState_TextColor and SetState_TextColor methods.
Notes
The TColor value specifies a 6 digit hexadecimal number of the $FFFFFF format.  For example the color blue would be RGB:0,0,255 and Hex:FF0000 therefore the converted decimal value would be 16711680.  The following formula may be used to calculate the required value, R+256*(G+(256*B)).
Example
HarnessEntry.TextColor := 0; // sets the name color to black.
See also
TColor type
ISch_HarnessEntry interface

OverrideDisplayString

(ISch_HarnessEntry interface)
Syntax
Property OverrideDisplayString : WideString Read GetState_OverrideDisplayString Write SetState_OverrideDisplayString;
Description
The OverrideDisplayString property defines the OverRideDisplayString property. This property is supported by the GetState_OverrirdeDisplayString and SetState_OverrirdeDisplayString methods.
Example
HarnessEntry.OverrideDisplayString(‘Display String overridden.’);
See also
ISch_HarnessEntry interface

OwnerHarnessConnector

(ISch_HarnessEntry interface)
Syntax
Property OwnerHarnessConnector : ISch_HarnessConnector Read GetState_SchOwnerHarnessConnector;
Description
The OwnerHarnessConnector property retrieves the HarnessConnector interface this harness entry is associated with. This property is supported by the GetState_OwnerHarnessConnector method.
Example
HarnessConnector := HarnessEntry.GetState_OwnerHarnessConnector;
See also
ISch_HarnessEntry interface

IHarnessTypeHolder Interface

Overview
The IHarnessTypeHolder

IHarnessTypeHolder methods
SetState_HarnessType
SetState_HarnessTypeInferred
SetState_IsHarnessObject
GetState_HarnessType
GetState_HarnessTypeInferred
GetState_IsHarnessObject
IHarnessTypeHolder properties
HarnessType
HarnessTypeInferred
IsHarnessObject

Methods

SetState_HarnessType
SetState_HarnessTypeInferred
SetState_IsHarnessObject
GetState_HarnessType
GetState_HarnessTypeInferred
GetState_IsHarnessObject

Properties

HarnessType
HarnessTypeInferred
IsHarnessObject

ISch_Image Interface

Overview
The ISch_Image interfaces are used to represent graphical images on a schematic document.
Notes
The ISch_Image interface hierarchy is as follows:
ISch_GraphicalObject
    ISch_Rectangle
        ISch_Image

ISch_Image methods
SetState_FileName
SetState_EmbedImage
SetState_KeepAspect
GetState_FileName
GetState_EmbedImage
GetState_KeepAspect
ISch_Image properties
EmbedImage
FileName
KeepAspect

See also
ISch_GraphicalObject interface
ISch_Rectangle interface

Methods

SetState_FileName method

(ISch_Image interface)
Syntax
Procedure SetState_FileName (Const Value : WideString);
Description
Example
See also
ISch_Image interface

SetState_EmbedImage method

(ISch_Image interface)
Syntax
Procedure SetState_EmbedImage (Const Value : Boolean);
Description
Example
See also
ISch_Image interface

GetState_KeepAspect method

(ISch_Image interface)
Syntax
Function GetState_KeepAspect : Boolean;
Description
Example
See also
ISch_Image interface

GetState_FileName method

(ISch_Image interface)
Syntax
Function GetState_FileName : WideString;
Description
Example
See also
ISch_Image interface

GetState_EmbedImage method

(ISch_Image interface)
Syntax
Function GetState_EmbedImage : Boolean;
Description
Example
See also
ISch_Image interface

SetState_KeepAspect method

(ISch_Image interface)
Syntax
Procedure SetState_KeepAspect (Const Value : Boolean);
Description
Example
See also
ISch_Image interface

Properties

KeepAspect property

(ISch_Image interface)
Syntax
Property KeepAspect : Boolean Read GetState_KeepAspect Write SetState_KeepAspect;
Description
Example
See also
ISch_Image interface

FileName property

(ISch_Image interface)
Syntax
Property FileName : WideString Read GetState_FileName Write SetState_FileName;
Description
Example
See also
ISch_Image interface

EmbedImage property

(ISch_Image interface)
Syntax
Property EmbedImage : Boolean Read GetState_EmbedImage Write SetState_EmbedImage;
Description
Example
See also
ISch_Image interface

ISch_Junction Interface

Overview
Junctions are small circular objects used to logically join intersecting wires on the schematic sheet. The ISch_Junction interfaces represent manually placed junctions NOT system generated junctions. You will use the IConnection interfaces to work with system generated junctions.
Notes
The ISch_Junction interface hierarchy is as follows:
ISch_GraphicalObject
     ISch_Junction
ISch_Junction Methods and Properties Table

ISch_Junction methods
SetState_Size
SetState_Locked
GetState_Size
GetState_Locked
ISch_Junction properties
Size
Locked

See also
ISch_GraphicalObject interface

ISch_Junction Methods

SetState_Size method

(ISch_Junction interface)
Syntax
Procedure SetState_Size (ASize : TSize);
Description
This procedure sets the size of the manual junction. The size is one of four values; Smallest, Small, Medium and Large. This method is also used by the Size property.
Example
ManualJunction.SetState_Size(eMedium);
See also
ISch_Junction interface
TSize type

SetState_Locked method

(ISch_Junction interface)
Syntax
Procedure SetState_Locked(ALocked : Boolean);
Description
This procedure sets the Locked state of the manual junction. This method is also used by the Locked property.
Example
ManualJunction.SetState_Locked(True);
See also
ISch_Junction interface

GetState_Size method

(ISch_Junction interface)
Syntax
Function GetState_Size : TSize;
Description
This function gets the size of the manual junction. The size is one of four values; Smallest, Small, Medium and Large. This method is also used by the Size property.
Example
Size := ManualJunction.GetState_Size;
See also
ISch_Junction interface
TSize type

GetState_Locked method

(ISch_Junction interface)
Syntax
Function GetState_Locked : Boolean;
Description
This function gets the Locked state of the manual junction. This method is also used by the Locked property.
Example
Locked := ManualJunction.GetState_Locked;
See also
ISch_Junction interface

Properties

Size property

(ISch_Junction interface)
Syntax
Property Size : TSize Read GetState_Size Write SetState_Size;
Description
This property represents the size of the manual junction. The GetState_Size and SetState_Size methods are used by this property.
Example
Junction.Size := eSmallest;
See also
ISch_Junction interface
TSize type.

Locked property

(ISch_Junction interface)
Syntax
Property Locked : Boolean Read GetState_Locked Write SetState_Locked;
Description
This property represents the Locked property of the manual junction. The GetState_Locked and SetState_Locked methods are used by this property.
Example
Junction.Locked := True;
See also
ISch_Junction interface

ISch_Label Interface

Overview
The ISch_Label interface represents an existing label object on a schematic document. This interface is the ancestor interface for the ISch_NetLabel interfaces.
Notes
The interface hierarchy for the ISch_Label interface is as follows:
ISch_GraphicalObject
    ISch_Label

ISch_Label methods
SetState_FontId
SetState_Orientation
SetState_Justification
SetState_OverrideDisplayString
SetState_IsMirrored
GetState_FontId
GetState_Orientation
GetState_Justification
GetState_DisplayString
GetState_Formula
GetState_CalculatedValueString
GetState_OverrideDisplayString
GetState_IsMirrored
ISch_Label properties
FontId
Orientation
Justification
Text
OverrideDisplayString
DisplayString
Formula
CalculatedValueString
IsMirrored

See also
ISch_GraphicalObject interface

Methods

SetState_OverrideDisplayString method

(ISch_Label interface)
Syntax
Procedure SetState_OverrideDisplayString(S : WideString );
Description
Example
See also
ISch_Label interface

SetState_Orientation method

(ISch_Label interface)
Syntax
Procedure SetState_Orientation (ARotation : TRotationBy90);
Description
This Orientation property determines the angle the ISch_Label is at on the Schematic document. The angle is in 90 degree increments - 0, 90, 180, 270. This property is supported by the GetState_Orientation and SetState_Orientation methods.
Example
SchLabel.Orientation := eRotate90;
Example
See also
ISch_Label interface

SetState_Justification method

(ISch_Label interface)
Syntax
Procedure SetState_Justification (AValue : TTextJustification);
Description
The Justification property determines the alignment of the text in respect to the Label object whether it is left justified, centered and so on. This property is supported by the GetState_Justification and SetState_Justification methods.
Example
See also
ISch_Label interface

SetState_IsMirrored method

(ISch_Label interface)
Syntax
Procedure SetState_IsMirrored (AValue : Boolean);
Description
Example
See also
ISch_Label interface

SetState_FontId method

(ISch_Label interface)
Syntax
Procedure SetState_FontId (AFontId : TFontID);
Description
Example
See also
ISch_Label interface

GetState_OverrideDisplayString method

(ISch_Label interface)
Syntax
Function GetState_OverrideDisplayString : WideString;
Description
The GetState_OverrrideDisplayString function returns the override display string which overrides the Name string.
Example
DisplayString := Label.GetState_OverrideDisplayString;
See also
ISch_Label interface

GetState_Orientation method

(ISch_Label interface)
Syntax
Function GetState_Orientation : TRotationBy90;
Description
This Orientation property determines the angle the ISch_Label is at on the Schematic document. The angle is in 90 degree increments - 0, 90, 180, 270. This property is supported by the GetState_Orientation and SetState_Orientation methods.
Example
SchLabel.Orientation := eRotate90;
See also
ISch_Label interface

GetState_Justification method

(ISch_Label interface)
Syntax
Function GetState_Justification : TTextJustification;
Description
The Justification property determines the alignment of the text in respect to the Label object whether it is left justified, centered and so on. This property is supported by the GetState_Justification and SetState_Justification methods.
Example
Justification := Label.GetState_Justification;
See also
ISch_Label interface

GetState_IsMirrored method

(ISch_Label interface)
Syntax
Function GetState_IsMirrored : Boolean;
Description
Example
See also
ISch_Label interface

GetState_Formula method

(ISch_Label interface)
Syntax
Function GetState_Formula : WideString;
Description
Example
See also
ISch_Label interface

GetState_FontId method

(ISch_Label interface)
Syntax
Function GetState_FontId : TFontID;
Description
Example
See also
ISch_Label interface

GetState_DisplayString method

(ISch_Label interface)
Syntax
Function GetState_DisplayString : WideString;
Description
Example
See also
ISch_Label interface

GetState_CalculatedValueString method

(ISch_Label interface)
Syntax
Function GetState_CalculatedValueString : WideString;
Description
Example
See also
ISch_Label interface

Properties

Text property

(ISch_Label interface)
Syntax
Property Text : WideString Read GetState_Text Write SetState_Text;
Description
The Text property of the ISch_Label represents the actual text string. This property is supported by the GetState_Text and SetState_Text methods.
Example

Location.X := MilsToCoord(1000);
Location.Y := MilsToCoord(1000);
SchLabel.SetState_Location(Location);
SchLabel.Color       := 12345;
Schlabel.Text        := 'A new name';
SchLabel.FontID      := SchServer.FontManager.GetFontID(14,90,False,False,False,False,'Times New Roman');

See also
ISch_Label interface

OverrideDisplayString property

(ISch_Label interface)
Syntax
Property OverrideDisplayString : WideString Read GetState_OverrideDisplayString Write SetState_OverrideDisplayString;
Description
The OverrrideDisplayString property determines the override display string which overrides the Name string. This property is supported by the GetState_OverrideDisplayString and SetState_OverrideDisplayString methods.
Example
DisplayString := SheetEntry.GetState_OverrideDisplayString;
See also
ISch_Label interface

Orientation property

(ISch_Label interface)
Syntax
Property Orientation : TRotationBy90 Read GetState_Orientation Write SetState_Orientation;
Description
This Orientation property determines the angle the ISch_Label is at on the Schematic document. The angle is in 90 degree increments - 0, 90, 180, 270. This property is supported by the GetState_Orientation and SetState_Orientation methods.
However if you are using the FontID property to be assigned by the FontManager (ISch_FontManger interface) then you will need to set the Orientation property as well as passing in the same rotation parameter for the GetFontID method of the ISch_FontManager interface.
Example

ALabel.Orientation := eRotate90;
ALabel.FontId      := SchServer.FontManager.GetFontID(14,90,False,False,False,False,'Times New Roman');

See also
ISch_Label interface

Justification property

(ISch_Label interface)
Syntax
Property Justification : TTextJustification Read GetState_Justification Write SetState_Justification;
Description
The Justification property determines the alignment of the text in respect to the Label object whether it is left justified, centered and so on. This property is supported by the GetState_Justification and SetState_Justification methods.
Example
See also
ISch_Label interface
TTextJustification type

IsMirrored property

(ISch_Label interface)
Syntax
Property IsMirrored : Boolean Read GetState_IsMirrored Write SetState_IsMirrored;
Description
Example
See also
ISch_Label interface

Formula property

(ISch_Label interface)
Syntax
Property Formula : WideString Read GetState_Formula;
Description
Example
See also
ISch_Label interface

FontId property

(ISch_Label interface)
Syntax
Property FontId : TFontID Read GetState_FontId Write SetState_FontId;
Description
The FontID property determines the style and type of font for the ISch_Label object on a Schematic document. This property is supported by the GetState_FontID and SetState_FontID methods.
Example

Location.X := MilsToCoord(1000);
Location.Y := MilsToCoord(1000);
SchLabel.SetState_Location(Location);
SchLabel.Color       := 12345;
Schlabel.Text        := 'A new name';
SchLabel.FontID      := SchServer.FontManager.GetFontID(14,90,False,False,False,False,'Times New Roman');

See also
ISch_Label interface
ISch_FontManager interface

DisplayString property

(ISch_Label interface)
Syntax
Property DisplayString : WideString Read GetState_DisplayString;
Description
Example
See also
ISch_Label interface

CalculatedValueString property

(ISch_Label interface)
Syntax
Property CalculatedValueString : WideString Read GetState_CalculatedValueString;
Description
Example
See also
ISch_Label interface

ISch_Line Interface

Overview
Lines are graphical drawing objects with any number of joined segments. A line object is represented by the ISch_Line interface.
Notes
The ISch_Line interface hierarchy is as follows:
ISch_GraphicalObject
    ISch_Line

ISch_Line methods
GetState_Corner
GetState_LineWidth
GetState_LineStyle
SetState_Corner
SetState_LineWidth
SetState_LineStyle
ISch_Line properties
Corner
LineWidth
LineStyle

Example

Procedure PlaceASchLine;
Var
    SchDoc    : ISch_Document;
    WorkSpace : IWorkSpace;
    SchLine   : ISch_Line;
Begin
    // Generate a blank Schematic document
    WorkSpace := GetWorkSpace;
    If WorkSpace = Nil Then Exit;
    Workspace.DM_CreateNewDocument('SCH');
 
    // Check if Schematic Editor is active
    If SchServer = Nil Then Exit;
    SchDoc := SchServer.GetCurrentSchDocument;
    If SchDoc = Nil Then Exit;
 
     // Create a new line and place it on the document.
     SchLine := SchServer.SchObjectFactory(eLine,eCreate_GlobalCopy);
     If SchLine = Nil Then Exit;
     SchLine.Location  := Point(180, 200);
     SchLine.Corner    := Point(180, 400);
     SchLine.LineWidth := eMedium;
     SchLine.LineStyle := eLineStyleSolid;
     SchLine.Color := $FF00FF;
     SchDoc.RegisterSchObjectInContainer(SchLine);
End;

See also
ISch_GraphicalObject interface

Methods

SetState_LineStyle method

(ISch_Line interface)
Syntax
Procedure SetState_LineStyle (AStyle : TLineStyle);
Description
Example
See also
ISch_Line interface

SetState_Corner method

(ISch_Line interface)
Syntax
Procedure SetState_Corner (ALocation : TLocation);
Description
Example
See also
ISch_Line interface

GetState_LineWidth method

(ISch_Line interface)
Syntax
Function GetState_LineWidth : TSize;
Description
This GetState_LineWidth function gets the width of the border around the line object. The width is determined by the TSize type.
Example
Width := Line.GetState_LineWidth; // Width is of TSize type.
See also
TSize type.
ISch_Line interface

GetState_LineStyle method

(ISch_Line interface)
Syntax
Function GetState_LineStyle : TLIneStyle;
Description
Example
See also
ISch_Line interface

GetState_Corner method

(ISch_Line interface)
Syntax
Function GetState_Corner : TLocation;
Description
Example
See also
ISch_Line interface

SetState_LineWidth method

(ISch_Line interface)
Syntax
Procedure SetState_LineWidth (ASize : TSize);
Description
This SetState_LineWidth procedure sets the width of the border line around the line. The width is determined by the TSize type.
Example
Line.SetState_LineWidth(eSmall);
See also
TSize type.
ISch_Line interface

Properties

LineWidth property

(ISch_Line interface)
Syntax
Property LineWidth : TSize Read GetState_LineWidth Write SetState_LineWidth;
Description
The LineWidth property defines the border width of the line with one of the following values from the TSize enumerated type. This property is supported by the GetState_LineWidth and SetState_LineWidth methods.
Example
Line.LineWidth(eSmall);
See also
TSize type.
ISch_Line interface

LineStyle property

(ISch_Line interface)
Syntax
Property LineStyle : TLineStyle Read GetState_LineStyle Write SetState_LineStyle;
Description
Example
See also
ISch_Line interface

Corner property

(ISch_Line interface)
Syntax
Property Corner : TLocation Read GetState_Corner Write SetState_Corner;
Description
Example
See also
ISch_Line interface

ISch_NetLabel Interface

Overview
A net describes a connection from one component pin, to a second pin, and then to a third pin and so on. A net label is a text string with the text property that holds the net name that attachs to a connection such as wires. A net label object is represented by the ISch_NetLabel interface.

The ISch_NetLabel interface hierachy is as follows:
ISch_GraphicalObject
ISch_Label
ISch_NetLabel

Text property is the net name of the net label.
ISch_NetLabel itself has no properties or methods but has inherited properties and methods.

ISch_NetLabel methods ISch_NetLabel properties

See also
ISch_GraphicalObject interface

ISch_NoERC Interface

Overview
The NoERC directive is a special symbol that identifies a pin as one that you want the Electrical Rules Checker to ignore.
The ISch_NoERC interface hierarchy is as follows:
ISch_GraphicalObject
ISch_NoERC

ISch_NoERC methods ISch_NoERC properties

See also
ISch_GraphicalObject interface

ISch_Note Interface

Overview
The ISch_Note interface represents the note object on the schematic sheet. This note object stores textual information and can be collapsed upon user's mouse click on the schematic sheet.
The interface hierarchy for the ISch_Note interface is as follows:
ISch_GraphicalObject
ISch_Rectangle
ISch_TextFrame
ISch_Note

ISch_Note methods
SetState_Author
SetState_Collapsed
GetState_Author
GetState_Collapsed
ISch_Note properties
Author
Collapsed

See also
ISch_GraphicalObject
ISch_Rectangle
ISch_TextFrame

Methods

SetState_Author method

(ISch_Note interface)
Syntax
Procedure SetState_Author (AValue : WideString);
Description
Example
See also
ISch_Note interface

GetState_Collapsed method

(ISch_Note interface)
Syntax
Function GetState_Collapsed : Boolean;
Description
Example
See also
ISch_Note interface

GetState_Author method

(ISch_Note interface)
Syntax
Function GetState_Author : WideString;
Description
Example
See also
ISch_Note interface

SetState_Collapsed method

(ISch_Note interface)
Syntax
Procedure SetState_Collapsed(AValue : Boolean);
Description
Example
See also
ISch_Note interface

Properties

Collapsed property

(ISch_Note interface)
Syntax
Property Collapsed : Boolean Read GetState_Collapsed Write SetState_Collapsed;
Description
Example
See also
ISch_Note interface

Author property

(ISch_Note interface)
Syntax
Property Author : WideString Read GetState_Author Write SetState_Author;
Description
Example
See also
ISch_Note interface

ISch_Parameter Interface

Overview
There are two types of parameters – system parameters which are owned by a schematic document and parameters owned by certain schematic design objects.

A parameter is a child object of a Parameter Set, Part, Pin, Port, or Sheet Symbol object. A Parameter object has a Name property and Value property which can be used to store information, thus the parameters are a way of defining and associating information and could include strings that identify component manufacturer, date added to the document and also a string for the component's value (e.g. 100K for a resistor or 10PF for a capacitor).

Each parameter has a Unique Id assigned to it. This is used for those parameters that have been added as design rule directives. When transferring the design to the PCB document, any defined rule parameters will be used to generate the relevant design rules in the PCB. These generated rules will be given the same Unique Ids, allowing you to change rule constraints in either schematic or PCB and push the change across when performing a synchronization.

To look for system wide parameters (not associated with a schematic design object), you would set up an iterator to look for parameters. WIth DelphiScript, you will have to define the iteration depth with the method SetState_IterationDepth(eIterateFirstLevel).

The interface hierarchy for the ISch_Parameter interface is as follows:
ISch_GraphicalObject
ISch_Label
ISch_ComplexText
ISch_Parameter

ISch_Parameter methods
SetState_ReadOnlyState
SetState_UniqueId
SetState_Description
SetState_AllowLibrarySynchronize
SetState_AllowDatabaseSynchronize
SetState_Name
SetState_ShowName
SetState_ParamType
GetState_ReadOnlyState
GetState_UniqueId
GetState_Description
GetState_AllowLibrarySynchronize
GetState_AllowDatabaseSynchronize
GetState_Name
GetState_ShowName
GetState_ParamType
GetState_NameIsReadOnly
GetState_ValueIsReadOnly
GetState_IsRule
GetState_IsSystemParameter
ISch_Parameter properties
Name
ShowName
ParamType
ReadOnlyState
UniqueId
Description
AllowLibrarySynchronize
AllowDatabaseSynchronize
NameIsReadOnly
ValueIsReadOnly
IsRule
IsSystemParameter

Fetching system (standalone) parameters Example

Procedure FetchParameters;
Var
    CurrentSch : ISch_Sheet;
    Iterator   : ISch_Iterator;
    Parameter  : ISch_Parameter;
Begin
    // Check if schematic server exists or not.
    If SchServer = Nil Then Exit;
    // Obtain the current schematic document interface.
    CurrentSch := SchServer.GetCurrentSchDocument;
    If CurrentSch = Nil Then Exit;
 
    Iterator := CurrentSch.SchIterator_Create;
    // look for stand alone parameters
    Iterator.SetState_IterationDepth(eIterateFirstLevel); 
    Iterator.AddFilter_ObjectSet(MkSet(eParameter)); 
 
    Try
       Parameter := Iterator.FirstSchObject;
       While Parameter <> Nil Do
       Begin
          // do what you want with the parameter
          Parameter := Iterator.NextSchObject;
       End;
    Finally
        CurrentSch.SchIterator_Destroy(Iterator);
    End;
End;

See also
ISch_GraphicalObject interface
ISch_Label interface
ISch_ComplexText interface

Methods

SetState_UniqueId method

(ISch_Parameter interface)
Syntax
Procedure SetState_UniqueId (S : WideString);
Description
The SetState_UniqueID procedure sets the new ID for the parameter. All parameters, sheet symbols, ports, pins, components, openbus links, openbus ports and openbus components have Unique IDs. Unique IDs are used to maintain design synchronization in design projects.

The Unique ID (UID) is an system generated value that uniquely identifies this current parameter. It is used for linking to a PCB document and for project management. Enter a new UID value or click the Reset button to generate a new UID for this design object from the Change Properties dialog. You can also globally reset UIDs of components and sheet symbols from the Schematic Editor’s Tools » Convert » Reset Component Unique IDs menu.
Example
UID := WSM.DM_GenerateUniqueID; // interface and method from Workspace Manager API.
Parameter.SetState_UniqueID(UID);

See also
ISch_Parameter interface

SetState_ShowName method

(ISch_Parameter interface)
Syntax
Procedure SetState_ShowName (N : Boolean);
Description
Example
See also
ISch_Parameter interface

SetState_ReadOnlyState method

(ISch_Parameter interface)
Syntax
Procedure SetState_ReadOnlyState (R : TParameter_ReadOnlyState);
Description
Example
See also
ISch_Parameter interface

SetState_ParamType method

(ISch_Parameter interface)
Syntax
Procedure SetState_ParamType (N : TParameterType);
Description
Example
See also
ISch_Parameter interface

SetState_Name method

(ISch_Parameter interface)
Syntax
Procedure SetState_Name (S : WideString);
Description
The SetState_Name procedure sets the new name for the parameter object.
Example
Parameter.SetState_Name(‘Parameter Name’);
See also
ISch_Parameter interface

SetState_Description method

(ISch_Parameter interface)
Syntax
Procedure SetState_Description (S : WideString);
Description
Example
See also
ISch_Parameter interface

SetState_AllowLibrarySynchronize method

(ISch_Parameter interface)
Syntax
Procedure SetState_AllowLibrarySynchronize (B : Boolean);
Description
Example
See also
ISch_Parameter interface

SetState_AllowDatabaseSynchronize method

(ISch_Parameter interface)
Syntax
Procedure SetState_AllowDatabaseSynchronize(B : Boolean);
Description
Example
See also
ISch_Parameter interface

GetState_UniqueId method

(ISch_Parameter interface)
Syntax
Function GetState_UniqueId : WideString;
Description
Example
See also
ISch_Parameter interface

GetState_ReadOnlyState method

(ISch_Parameter interface)
Syntax
Function GetState_ReadOnlyState : TParameter_ReadOnlyState;
Description
Example
See also
ISch_Parameter interface

GetState_Description method

(ISch_Parameter interface)
Syntax
Function GetState_Description : WideString;
Description
Example
See also
ISch_Parameter interface

GetState_AllowLibrarySynchronize method

(ISch_Parameter interface)
Syntax
Function GetState_AllowLibrarySynchronize : Boolean;
Description
Example
See also
ISch_Parameter interface

GetState_AllowDatabaseSynchronize method

(ISch_Parameter interface)
Syntax
Function GetState_AllowDatabaseSynchronize : Boolean;
Description
Example
See also
ISch_Parameter interface

GetState_ValueIsReadOnly method

(ISch_Parameter interface)
Syntax
Function GetState_ValueIsReadOnly : Boolean;
Description
Example
See also
ISch_Parameter interface

GetState_ShowName method

(ISch_Parameter interface)
Syntax
Function GetState_ShowName : Boolean;
Description
Example
See also
ISch_Parameter interface

GetState_ParamType method

(ISch_Parameter interface)
Syntax
Function GetState_ParamType : TParameterType;
Description
Example
See also
ISch_Parameter interface

GetState_NameIsReadOnly method

(ISch_Parameter interface)
Syntax
Function GetState_NameIsReadOnly : Boolean;
Description
Example
See also
ISch_Parameter interface

GetState_Name method

(ISch_Parameter interface)
Syntax
Function GetState_Name : WideString;
Description
The GetState_Name procedure gets the Parameter Object’s name.
Example
ParamName := Parameter.GetState_Name;
See also
ISch_Parameter interface

GetState_IsSystemParameter method

(ISch_Parameter interface)
Syntax
Function GetState_IsSystemParameter : Boolean;
Description
Example
See also
ISch_Parameter interface

GetState_IsRule method

(ISch_Parameter interface)
Syntax
Function GetState_IsRule : Boolean;
Description
Example
See also
ISch_Parameter interface

Properties

ValueIsReadOnly property

(ISch_Parameter interface)
Syntax
Property ValueIsReadOnly : Boolean Read GetState_ValueIsReadOnly;
Description
Example
See also
ISch_Parameter interface

UniqueId property

(ISch_Parameter interface)
Syntax
Property UniqueId : WideString Read GetState_UniqueId Write SetState_UniqueId;
Description
The UniqueID property sets the new ID for the parameter. All parameters, sheet symbols, ports, pins, components, openbus links, openbus ports and openbus components have Unique IDs. Unique IDs are used to maintain design synchronization in design projects.

The Unique ID (UID) is an system generated value that uniquely identifies this current parameter. It is used for linking to a PCB document and for project management. Enter a new UID value or click the Reset button to generate a new UID for this design object from the Change Properties dialog. You can also globally reset UIDs of components and sheet symbols from the Schematic Editor’s Tools » Convert » Reset Component Unique IDs menu.
Example
UID := WSM.DM_GenerateUniqueID; // interface and method from Workspace Manager API.
Parameter.UniqueID(UID);

See also
ISch_Parameter interface

ShowName property

(ISch_Parameter interface)
Syntax
Property ShowName : Boolean Read GetState_ShowName Write SetState_ShowName;
Description
Example
See also
ISch_Parameter interface

ReadOnlyState property

(ISch_Parameter interface)
Syntax
Property ReadOnlyState : TParameter_ReadOnlyState Read GetState_ReadOnlyState Write SetState_ReadOnlyState;
Description
Example
See also
ISch_Parameter interface

ParamType property

(ISch_Parameter interface)
Syntax
Property ParamType : TParameterType Read GetState_ParamType Write SetState_ParamType;
Description
Example
See also
ISch_Parameter interface

NameIsReadOnly property

(ISch_Parameter interface)
Syntax
Property NameIsReadOnly : Boolean Read GetState_NameIsReadOnly;
Description
Example
See also
ISch_Parameter interface

Name property

(ISch_Parameter interface)
Syntax
Property Name : WideString Read GetState_Name Write SetState_Name;
Description
The Name property determines the name for the parameter object.
Example
ParamName := Parameter.Name;
See also
ISch_Parameter interface

Description property

(ISch_Parameter interface)
Syntax
Property Description : WideString Read GetState_Description Write SetState_Description;
Description
Example
See also
ISch_Parameter interface

AllowLibrarySynchronize property

(ISch_Parameter interface)
Syntax
Property AllowLibrarySynchronize : Boolean Read GetState_AllowLibrarySynchronize Write SetState_AllowLibrarySynchronize;
Description
Example
See also
ISch_Parameter interface

AllowDatabaseSynchronize property

(ISch_Parameter interface)
Syntax
Property AllowDatabaseSynchronize : Boolean Read GetState_AllowDatabaseSynchronize Write SetState_AllowDatabaseSynchronize;
Description
Example
See also
ISch_Parameter interface

IsSystemParameter property

(ISch_Parameter interface)
Syntax
Property IsSystemParameter : Boolean Read GetState_IsSystemParameter;
Description
Example
See also
ISch_Parameter interface

IsRule property

(ISch_Parameter interface)
Syntax
Property IsRule : Boolean Read GetState_IsRule;
Description
Example
See also
ISch_Parameter interface

ISch_ParameterSet Interface

Overview
The ISch_ParameterSet interface is a group of parameters as a design parameter set directive for a wire or a net on the schematic document that can be transferred to its corresponding PCB document.
Notes
The ISch_ParameterSet interface hierarchy is as follows
ISch_GraphicalObject
    ISch_ParametrizedGroup
        ISch_ParameterSet

ISch_ParameterSet methods
SetState_Orientation
SetState_Name
GetState_Orientation
GetState_Name
ISch_ParameterSet properties
Orientation
Name

See also
ISch_GraphicalObject interface
ISch_ParametrizedGroup interface

Methods

SetState_Name method

(ISch_ParameterSet interface)
Syntax
Procedure SetState_Name (AValue : WideString);
Description
The SetState_Name procedure sets the new name for the parameterset object.
Example
ParameterSet.SetState_Name(‘Specific Name’);
See also
ISch_ParameterSet interface

GetState_Orientation method

(ISch_ParameterSet interface)
Syntax
Function GetState_Orientation : TRotationBy90;
Description
Example
See also
ISch_ParameterSet interface

GetState_Name method

(ISch_ParameterSet interface)
Syntax
Function GetState_Name : WideString;
Description
The GetState_Name function gets the new name for the parameter set object.
Example
Name := ParameterSet.GetState_Name;
See also
ISch_ParameterSet interface

SetState_Orientation method

(ISch_ParameterSet interface)
Syntax
Procedure SetState_Orientation(AValue : TRotationBy90);
Description
Example
See also
ISch_ParameterSet interface

Properties

Orientation property

(ISch_ParameterSet interface)
Syntax
Property Orientation : TRotationBy90 Read GetState_Orientation Write SetState_Orientation;
Description
Example
See also
ISch_ParameterSet interface

Name property

(ISch_ParameterSet interface)
Syntax
Property Name : WideString Read GetState_Name Write SetState_Name;
Description
The Name property determines the Parameter Set obejct’s name. This property is supported by the GetState_Name and SetState_Name methods.
Example
ParamSetName := ParameterSet.Name;
See also
ISch_ParameterSet interface

ISch_ParametrizedGroup Interface

Overview
The ISch_ParametrizedGroup is an immediate ancestor interface for ParameterSet, Port, Pin, Component and SheetSymbol interfaces. This interface deals with positions of parameters of such objects..
Notes
The ISch_ParametrizedGroup interface hierarchy is as follows
ISch_GraphicalObject
    ISch_ParameterizedGroup

ISch_ParametrizedGroup methods
Import_FromUser_Parameters
ResetAllSchParametersPosition
ISch_ParametrizedGroup properties

See also
ISch_GraphicalObject ancestor interface
ISch_ParameterSet descendent interface
ISch_Port descendent interface
ISch_Pin descendent interface
ISch_Component descendent interface
ISch_RectangularGroup descendent interface
ISch_SheetSymbol descendent interface

Methods

Import_FromUser_Parameters method

(ISch_ParametrizedGroup interface)
Syntax
Function Import_FromUser_Parameters : Boolean;
Description
Example
See also
ISch_ParametrizedGroup interface

ResetAllSchParametersPosition method

(ISch_ParametrizedGroup interface)
Syntax
Procedure ResetAllSchParametersPosition;
Description
Example
See also
ISch_ParametrizedGroup interface

ISch_Pie Interface

Overview
Pie objects are unfilled or filled graphic elements.
Notes
The ISch_Pie interface hierarchy is as follows:
ISch_GraphicalObject
    ISch_Arc
        ISch_Pie

ISch_Pie methods
GetState_IsSolid
SetState_IsSolid
ISch_Pie properties
IsSolid

See also
ISch_Arc interface.

Methods

GetState_IsSolid method

(ISch_Pie interface)
Syntax
Function GetState_IsSolid : Boolean;
Description
The GetState_IsSolid function returns a Boolean value whether the pie object has a solid internal fill or not.
Example

If Pie.GetState_IsSolid Then
    Pie. AreaColor := 0; // black fill

See also
ISch_Pie interface

SetState_IsSolid method

(ISch_Pie interface)
Syntax
Procedure SetState_IsSolid(B : Boolean);
Description
The SetState_IsSolid procedure sets a Boolean value which denotes that the pie object has a solid internal fill or not.
Example

Pie.SetState_IsSolid(True);
Pie.AreaColor := 0;

See also
ISch_Pie interface

Properties

IsSolid property

(ISch_Pie interface)
Syntax
Property IsSolid : Boolean Read GetState_IsSolid Write SetState_IsSolid;
Description
The IsSolid property denotes whether the pie object has a solid fill or not. This property is supported by the GetState_IsSolid and SetState_IsSolid methods.
Example
Pie.IsSolid := True;
See also
ISch_Pie interface

ISch_Pin Interface

Overview
Pins are special objects that have electrical characteristics and are used to direct signals in and out of components. Pins connect directly to other pins, wires, net labels, sheet entries or ports.
Notes
The ISch_Pin interface hierarchy is as follows:
ISch_GraphicalObject
    ISch_ParameterizedGroup
        ISch_Pin

ISch_Pin methods
SetState_Name
SetState_Designator
SetState_Orientation
SetState_Width
SetState_FormalType
SetState_DefaultValue
SetState_Description
SetState_ShowName
SetState_ShowDesignator
SetState_Electrical
SetState_PinLength
SetState_IsHidden
SetState_HiddenNetName
SetState_Symbol_Inner
SetState_Symbol_Outer
SetState_Symbol_InnerEdge
SetState_Symbol_OuterEdge
SetState_SwapIdPart
SetState_SwapIdPin
SetState_SwapIdPartPin
SetState_UniqueId
GetState_Name
GetState_Designator
GetState_Orientation
GetState_Width
GetState_FormalType
GetState_DefaultValue
GetState_Description
GetState_ShowName
GetState_ShowDesignator
GetState_Electrical
GetState_PinLength
GetState_IsHidden
GetState_HiddenNetName
GetState_Symbol_Inner
GetState_Symbol_Outer
GetState_Symbol_InnerEdge
GetState_Symbol_OuterEdge
GetState_SwapIdPart
GetState_SwapIdPin
GetState_SwapIdPartPin
GetState_UniqueId
OwnerSchComponent
FullDesignator
ISch_Pin properties
Name
Designator
Orientation
Width
FormalType
DefaultValue
Description
ShowName
ShowDesignator
Electrical
PinLength
IsHidden
HiddenNetName
Symbol_Inner
Symbol_Outer
Symbol_InnerEdge
Symbol_OuterEdge
SwapId_Part
SwapId_Pin
SwapId_PartPin
UniqueId

See also
ISch_GraphicalObject interface
ISch_ParametrizedGroup interface

Methods

GetState_UniqueId method

(ISch_Pin interface)
Syntax
Function GetState_UniqueId : WideString;
Description
Example
See also
ISch_Pin interface

GetState_Symbol_OuterEdge method

(ISch_Pin interface)
Syntax
Function GetState_Symbol_OuterEdge : TIeeeSymbol;
Description
Example
See also
ISch_Pin interface

GetState_Symbol_Outer method

(ISch_Pin interface)
Syntax
Function GetState_Symbol_Outer : TIeeeSymbol;
Description
Example
See also
ISch_Pin interface

GetState_Symbol_InnerEdge method

(ISch_Pin interface)
Syntax
Function GetState_Symbol_InnerEdge : TIeeeSymbol;
Description
Example
See also
ISch_Pin interface

GetState_Symbol_Inner method

(ISch_Pin interface)
Syntax
Function GetState_Symbol_Inner : TIeeeSymbol;
Description
Example
See also
ISch_Pin interface

GetState_SwapIdPin method

(ISch_Pin interface)
Syntax
Function GetState_SwapIdPin : WideString;
Description
Example
See also
ISch_Pin interface

GetState_SwapIdPartPin method

(ISch_Pin interface)
Syntax
Function GetState_SwapIdPartPin : WideString;
Description
Example
See also
ISch_Pin interface

GetState_SwapIdPart method

(ISch_Pin interface)
Syntax
Function GetState_SwapIdPart : WideString;
Description
Example
See also
ISch_Pin interface

SetState_Name method

(ISch_Pin interface)
Syntax
Procedure SetState_Name (AValue : WideString);
Description
The SetState_Name procedure sets the new name for the Pin object.
Example
Pin.SetState_Name(‘40’);
See also
ISch_Pin interface

SetState_Designator method

(ISch_Pin interface)
Syntax
Procedure SetState_Designator (AValue : WideString);
Description
Example
See also
ISch_Pin interface

SetState_Width method

(ISch_Pin interface)
Syntax
Procedure SetState_Width (AValue : Integer);
Description
Example
See also
ISch_Pin interface

SetState_Symbol_OuterEdge method

(ISch_Pin interface)
Syntax
Procedure SetState_Symbol_OuterEdge(AValue : TIeeeSymbol);
Description
Example
See also
ISch_Pin interface

SetState_Symbol_Outer method

(ISch_Pin interface)
Syntax
Procedure SetState_Symbol_Outer (AValue : TIeeeSymbol);
Description
Example
See also
ISch_Pin interface

SetState_Symbol_InnerEdge method

(ISch_Pin interface)
Syntax
Procedure SetState_Symbol_InnerEdge(AValue : TIeeeSymbol);
Description
Example
See also
ISch_Pin interface

SetState_Symbol_Inner method

(ISch_Pin interface)
Syntax
Procedure SetState_Symbol_Inner (AValue : TIeeeSymbol);
Description
Example
See also
ISch_Pin interface

SetState_SwapIdPart method

(ISch_Pin interface)
Syntax
Procedure SetState_SwapIdPart (AValue : WideString);
Description
Example
See also
ISch_Pin interface

SetState_ShowName method

(ISch_Pin interface)
Syntax
Procedure SetState_ShowName (AValue : Boolean);
Description
Example
See also
ISch_Pin interface

SetState_ShowDesignator method

(ISch_Pin interface)
Syntax
Procedure SetState_ShowDesignator (AValue : Boolean);
Description
Example
See also
ISch_Pin interface

SetState_PinLength method

(ISch_Pin interface)
Syntax
Procedure SetState_PinLength (AValue : TCoord);
Description
Example
See also
ISch_Pin interface

SetState_Orientation method

(ISch_Pin interface)
Syntax
Procedure SetState_Orientation (AValue : TRotationBy90);
Description
Example
See also
ISch_Pin interface

SetState_IsHidden method

(ISch_Pin interface)
Syntax
Procedure SetState_IsHidden (AValue : Boolean);
Description
Example
See also
ISch_Pin interface

SetState_HiddenNetName method

(ISch_Pin interface)
Syntax
Procedure SetState_HiddenNetName (AValue : WideString);
Description
Example
See also
ISch_Pin interface

SetState_FormalType method

(ISch_Pin interface)
Syntax
Procedure SetState_FormalType (AValue : TStdLogicState);
Description
Example
See also
ISch_Pin interface

SetState_Electrical method

(ISch_Pin interface)
Syntax
Procedure SetState_Electrical (AValue : TPinElectrical);
Description
Example
See also
ISch_Pin interface

SetState_Description method

(ISch_Pin interface)
Syntax
Procedure SetState_Description (AValue : WideString);
Description
Example
See also
ISch_Pin interface

SetState_DefaultValue method

(ISch_Pin interface)
Syntax
Procedure SetState_DefaultValue (AValue : WideString);
Description
Example
See also
ISch_Pin interface

SetState_UniqueId method

(ISch_Pin interface)
Syntax
Procedure SetState_UniqueId (AValue : WideString);
Description
The SetState_UniqueID procedure sets the new ID for the pin. All parameters, sheet symbols, ports, pins, components, openbus links, openbus ports and openbus components have Unique IDs. Unique IDs are used to maintain design synchronization in design projects.

The Unique ID (UID) is an system generated value that uniquely identifies this current pin. It is used for linking to a PCB document and for project management. Enter a new UID value or click the Reset button to generate a new UID for this design object from the Change Properties dialog. You can also globally reset UIDs of components and sheet symbols from the Schematic Editor’s Tools » Convert » Reset Component Unique IDs menu.
Example
UID := WSM.DM_GenerateUniqueID; // interface and method from Workspace Manager API.
Pin.SetState_UniqueID(UID);

See also
ISch_Pin interface

SetState_SwapIdPin method

(ISch_Pin interface)
Syntax
Procedure SetState_SwapIdPin (AValue : WideString);
Description
Example
See also
ISch_Pin interface

SetState_SwapIdPartPin method

(ISch_Pin interface)
Syntax
Procedure SetState_SwapIdPartPin (AValue : WideString);
Description
Example
See also
ISch_Pin interface

GetState_Width method

(ISch_Pin interface)
Syntax
Function GetState_Width : Integer;
Description
Example
See also
ISch_Pin interface

GetState_ShowName method

(ISch_Pin interface)
Syntax
Function GetState_ShowName : Boolean;
Description
Example
See also
ISch_Pin interface

GetState_ShowDesignator method

(ISch_Pin interface)
Syntax
Function GetState_ShowDesignator : Boolean;
Description
Example
See also
ISch_Pin interface

GetState_PinLength method

(ISch_Pin interface)
Syntax
Function GetState_PinLength : TCoord;
Description
Example
See also
ISch_Pin interface

GetState_Orientation method

(ISch_Pin interface)
Syntax
Function GetState_Orientation : TRotationBy90;
Description
Example
See also
ISch_Pin interface

GetState_Name method

(ISch_Pin interface)
Syntax
Function GetState_Name : WideString;
Description
The GetState_Name function gets the name for the Pin object.
Example
PinName := Pin.GetState_Name;
See also
ISch_Pin interface

GetState_IsHidden method

(ISch_Pin interface)
Syntax
Function GetState_IsHidden : Boolean;
Description
Example
See also
ISch_Pin interface

GetState_HiddenNetName method

(ISch_Pin interface)
Syntax
Function GetState_HiddenNetName : WideString;
Description
Example
See also
ISch_Pin interface

GetState_FormalType method

(ISch_Pin interface)
Syntax
Function GetState_FormalType : TStdLogicState;
Description
Example
See also
ISch_Pin interface

GetState_Electrical method

(ISch_Pin interface)
Syntax
Function GetState_Electrical : TPinElectrical;
Description
Example
See also
ISch_Pin interface

GetState_Designator method

(ISch_Pin interface)
Syntax
Function GetState_Designator : WideString;
Description
Example
See also
ISch_Pin interface

GetState_Description method

(ISch_Pin interface)
Syntax
Function GetState_Description : WideString;
Description
Example
See also
ISch_Pin interface

GetState_DefaultValue method

(ISch_Pin interface)
Syntax
Function GetState_DefaultValue : WideString;
Description
Example
See also
ISch_Pin interface

Properties

Width property

(ISch_Pin interface)
Syntax
Property Width : Integer Read GetState_Width Write SetState_Width ;
Description
Example
See also
ISch_Pin interface

OwnerSchComponent method

(ISch_Pin interface)
Syntax
Function OwnerSchComponent : ISch_Component;
Description
Example
See also
ISch_Pin interface

Orientation property

(ISch_Pin interface)
Syntax
Property Orientation : TRotationBy90 Read GetState_Orientation Write SetState_Orientation ;
Description
Example
See also
ISch_Pin interface

Name property

(ISch_Pin interface)
Syntax
Property Name : WideString Read GetState_Name Write SetState_Name ;
Description
The Name property determines the name for the Pin object. This property is supported by the GetState_Name and SetState_Name methods.
Example
PinName := Pin.Name;
See also
ISch_Pin interface

FullDesignator method

(ISch_Pin interface)
Syntax
Function FullDesignator : WideString;
Description
Example
See also
ISch_Pin interface

FormalType property

(ISch_Pin interface)
Syntax
Property FormalType : TStdLogicState Read GetState_FormalType Write SetState_FormalType ;
Description
Example
See also
ISch_Pin interface

Designator property

(ISch_Pin interface)
Syntax
Property Designator : WideString Read GetState_Designator Write SetState_Designator ;
Description
Example
See also
ISch_Pin interface

Description property

(ISch_Pin interface)
Syntax
Property Description : WideString Read GetState_Description Write SetState_Description ;
Description
Example
See also
ISch_Pin interface

DefaultValue property

(ISch_Pin interface)
Syntax
Property DefaultValue : WideString Read GetState_DefaultValue Write SetState_DefaultValue ;
Description
Example
See also
ISch_Pin interface

UniqueId property

(ISch_Pin interface)
Syntax
Property UniqueId : WideString Read GetState_UniqueId Write SetState_UniqueId ;
Description
The UniqueID property sets the new ID for the pin. All parameters, sheet symbols, ports, pins, components, openbus links, openbus ports and openbus components have Unique IDs. Unique IDs are used to maintain design synchronization in design projects.

The Unique ID (UID) is an system generated value that uniquely identifies this current sheet symbol. It is used for linking to a PCB document and for project management. Enter a new UID value or click the Reset button to generate a new UID for this design object from the Change Properties dialog. You can also globally reset UIDs of components and sheet symbols from the Schematic Editor’s Tools » Convert » Reset Component Unique IDs menu.
Example

UID := WSM.DM_GenerateUniqueID; // interface and method from Workspace Manager API.
Pin.UniqueID(UID);

See also
ISch_Pin interface

Symbol_OuterEdge property

(ISch_Pin interface)
Syntax
Property Symbol_OuterEdge : TIeeeSymbol Read GetState_Symbol_OuterEdge Write SetState_Symbol_OuterEdge;
Description
Example
See also
ISch_Pin interface

Symbol_Outer property

(ISch_Pin interface)
Syntax
Property Symbol_Outer : TIeeeSymbol Read GetState_Symbol_Outer Write SetState_Symbol_Outer ;
Description
Example
See also
ISch_Pin interface

Symbol_InnerEdge property

(ISch_Pin interface)
Syntax
Property Symbol_InnerEdge : TIeeeSymbol Read GetState_Symbol_InnerEdge Write SetState_Symbol_InnerEdge;
Description
Example
See also
ISch_Pin interface

Symbol_Inner property

(ISch_Pin interface)
Syntax
Property Symbol_Inner : TIeeeSymbol Read GetState_Symbol_Inner Write SetState_Symbol_Inner ;
Description
Example
See also
ISch_Pin interface

SwapId_Pin property

(ISch_Pin interface)
Syntax
Property SwapId_Pin : WideString Read GetState_SwapIdPin Write SetState_SwapIdPin ;
Description
Example
See also
ISch_Pin interface

SwapId_PartPin property

(ISch_Pin interface)
Syntax
Property SwapId_PartPin : WideString Read GetState_SwapIdPartPin Write SetState_SwapIdPartPin ;
Description
Example
See also
ISch_Pin interface

SwapId_Part property

(ISch_Pin interface)
Syntax
Property SwapId_Part : WideString Read GetState_SwapIdPart Write SetState_SwapIdPart ;
Description
Example
See also
ISch_Pin interface

ShowName property

(ISch_Pin interface)
Syntax
Property ShowName : Boolean Read GetState_ShowName Write SetState_ShowName ;
Description
Example
See also
ISch_Pin interface

ShowDesignator property

(ISch_Pin interface)
Syntax
Property ShowDesignator : Boolean Read GetState_ShowDesignator Write SetState_ShowDesignator ;
Description
Example
See also
ISch_Pin interface

PinLength property

(ISch_Pin interface)
Syntax
Property PinLength : TCoord Read GetState_PinLength Write SetState_PinLength ;
Description
Example
See also
ISch_Pin interface

IsHidden property

(ISch_Pin interface)
Syntax
Property IsHidden : Boolean Read GetState_IsHidden Write SetState_IsHidden ;
Description
Example
See also
ISch_Pin interface

HiddenNetName property

(ISch_Pin interface)
Syntax
Property HiddenNetName : WideString Read GetState_HiddenNetName Write SetState_HiddenNetName ;
Description
Example
See also
ISch_Pin interface

Electrical property

(ISch_Pin interface)
Syntax
Property Electrical : TPinElectrical Read GetState_Electrical Write SetState_Electrical ;
Description
Example
See also
ISch_Pin interface

ISch_Polygon Interface

Overview
Polygons are multi-sided graphical elements.  The vertices of a polygon object denote the link of lines to describe its outline.

The ISch_Polygon interface hierarchy is as follows:
ISch_GraphicalObject
    ISch_Polygon interface

ISch_Polygon methods
SetState_LineWidth
SetState_IsSolid
SetState_Vertex
SetState_VerticesCount
SetState_Transparent
GetState_LineWidth
GetState_IsSolid
GetState_Vertex
GetState_VerticesCount
GetState_Transparent
InsertVertex
RemoveVertex
ClearAllVertices
ISch_Polygon properties
IsSolid
LineWidth
Vertex
VerticesCount
Transparent

See also
ISch_GraphicalObject interface
ISch_Polyline interface
ISch_Wire interface
ISch_Bus interface
TLocation values
TSize enumerated values

Methods

SetState_LineWidth method

(ISch_Polygon interface)
Syntax
Procedure SetState_LineWidth (AValue : TSize);
Description
This SetState_LineWidth procedure sets the width of the border line around the polygon. The width is determined by the TSize type.
Example
Polygon.SetState_LineWidth(eSmall);
See also
TSize type.
ISch_Polygon interface

SetState_VerticesCount method

(ISch_Polygon interface)
Syntax
Procedure SetState_VerticesCount(AValue : Integer);
Description
Example
See also
ISch_Polygon interface

SetState_Vertex method

(ISch_Polygon interface)
Syntax
Procedure SetState_Vertex (i : Integer; ALocation : TLocation);
Description
Example
See also
ISch_Polygon interface

SetState_Transparent method

(ISch_Polygon interface)
Syntax
Procedure SetState_Transparent (B : Boolean);
Description
Example
See also
ISch_Polygon interface

SetState_IsSolid method

(ISch_Polygon interface)
Syntax
Procedure SetState_IsSolid (AValue : Boolean);
Description
Example
See also
ISch_Polygon interface

GetState_VerticesCount method

(ISch_Polygon interface)
Syntax
Function GetState_VerticesCount : Integer;
Description
Example
See also
ISch_Polygon interface

GetState_Vertex method

(ISch_Polygon interface)
Syntax
Function GetState_Vertex(i : Integer) : TLocation;
Description
Example
See also
ISch_Polygon interface

GetState_Transparent method

(ISch_Polygon interface)
Syntax
Function GetState_Transparent : Boolean;
Description
Example
See also
ISch_Polygon interface

GetState_LineWidth method

(ISch_Polygon interface)
Syntax
Function GetState_LineWidth : TSize;
Description
This GetState_LineWidth procedure gets the width of the border line around the line. The width is determined by the TSize type.
Example
LineWidth := Polygon.GetState_LineWidth;
See also
ISch_Polygon interface

GetState_IsSolid method

(ISch_Polygon interface)
Syntax
Function GetState_IsSolid : Boolean;
Description
Example
See also
ISch_Polygon interface

RemoveVertex method

(ISch_Polygon interface)
Syntax
Function RemoveVertex (Var Index : Integer) : Boolean;
Description
Example
See also
ISch_Polygon interface

InsertVertex method

(ISch_Polygon interface)
Syntax
Function InsertVertex ( Index : Integer) : Boolean;
Description
Example
See also
ISch_Polygon interface

ClearAllVertices method

(ISch_Polygon interface)
Syntax
Procedure ClearAllVertices;
Description
Example
See also
ISch_Polygon interface

Properties

VerticesCount property

(ISch_Polygon interface)
Syntax
Property VerticesCount : Integer Read GetState_VerticesCount Write Setstate_VerticesCount;
Description
Example
See also
ISch_Polygon interface

Transparent property

(ISch_Polygon interface)
Syntax
Property Transparent : Boolean Read GetState_Transparent Write SetState_Transparent;
Description
Example
See also
ISch_Polygon interface

LineWidth property

(ISch_Polygon interface)
Syntax
Property LineWidth : TSize Read GetState_LineWidth Write SetState_LineWidth;
Description
The LineWidth property defines the border width of the polygon with one of the following values from the TSize enumerated type. This property is supported by the GetState_LineWidth and SetState_LineWidth methods.
Example
Polygon.LineWIdth := eSmall;
See also
TSize type
ISch_Polygon interface

IsSolid property

(ISch_Polygon interface)
Syntax
Property IsSolid : Boolean Read GetState_IsSolid Write SetState_IsSolid;
Description
Example
See also
ISch_Polygon interface

Vertex property

(ISch_Polygon interface)
Syntax
Property Vertex[i : Integer] : TLocation Read GetState_Vertex Write SetState_Vertex;
Description
Example
See also
ISch_Polygon interface
TLocation type

ISch_BasicPolyline Interface

Overview
Lines are graphical drawing objects with any number of joined segments.
Notes
The ISch_BasicPolyline interface hierarchy is as follows:
ISch_GraphicalObject
    ISch_Polygon
        ISch_BasicPolyline
            ISch_Polyline

ISch_BasicPolyline methods
SetState_LineStyle
GetState_LineStyle
ISch_BasicPolyline properties
LineStyle

See also
ISch_GraphicalObject interface
ISch_Polygon interface
ISch_Polyline interface

Methods

GetState_LineStyle method

(ISch_BasicPolyline interface)
Syntax
Function GetState_LineStyle : TLineStyle;
Description
Example
See also
ISch_BasicPolyline interface

SetState_LineStyle method

(ISch_BasicPolyline interface)
Syntax
Procedure SetState_LineStyle(AValue : TLineStyle);
Description
Example
See also
ISch_BasicPolyline interface

Properties

LineStyle property

(ISch_BasicPolyline interface)
Syntax
Property LineStyle : TLineStyle Read GetState_LineStyle Write SetState_LineStyle;
Description
Example
See also
ISch_BasicPolyline interface

ISch_Polyline Interface

Overview
Lines are graphical drawing objects with any number of joined segments.
Notes
The ISch_Polyline interface hierarchy is as follows:
ISch_GraphicalObject
    ISch_Polygon
        ISch_BasicPolyline
            ISch_Polyline

ISch_Polyline methods
GetState_StartLineShape
SetState_StartLineShape
GetState_EndLineShape 
SetState_EndLineShape 
GetState_LineShapeSize
SetState_LineShapeSize
ISch_Polyline properties
StartLineShape
EndLineShape 
LineShapeSize

See also
ISch_GraphicalObject interface
ISch_Polygon interface
ISch_BasicPolyline interface

Methods

GetState_StartLineShape method

(ISch_Polyline interface)
Syntax
Function  GetState_StartLineShape        : TLineShape;
Description
Example
See also
ISch_Polyline interface

GetState_EndLineShape method

(ISch_Polyline interface)
Syntax
Function  GetState_EndLineShape          : TLineShape;
Description
Example
See also
ISch_Polyline interface

GetState_LineShapeSize method

(ISch_Polyline interface)
Syntax
Function  GetState_LineShapeSize         : TSize;
Description
Example
See also
ISch_Polyline interface

SetState_StartLineShape method

(ISch_Polyline interface)
Syntax
Procedure SetState_StartLineShape(AValue : TLineShape);
Description
Example
See also
ISch_Polyline interface

SetState_EndLineShape method

(ISch_Polyline interface)
Syntax
Procedure SetState_EndLineShape  (AValue : TLineShape);
Description
Example
See also
ISch_Polyline interface

SetState_LineShapeSize method

(ISch_Polyline interface)
Syntax
Procedure SetState_LineShapeSize (AValue : TSize);
Description
Example
See also
ISch_Polyline interface

Properties

LineStyle property

(ISch_Polyline interface)
Syntax
Property LineStyle : TLineStyle Read GetState_LineStyle Write SetState_LineStyle;
Description
Example
See also
ISch_Polyline interface

ISch_Port Interface

Overview
A port is used to connect a net on one sheet to Ports with the same name on other sheets.  Ports can also connect from child sheets to Sheet entries, in the appropriate sheet symbol on the parent sheet.

The port cross referencing information for ports on different schematics linked to sheet entries of a sheet symbol can be added to schematic sheets by executing the Reports » Port Cross Reference » Add To Sheet or Add to Project command within Schematic Editor in Altium Designer.
Notes
To obtain the cross reference field of a port, the design project needs to be compiled first and then port cross-referencing information added to the project or the sheet.

Port cross references are a calculated attribute of ports, they can not be edited and are not stored with the design.

The location of each port reference is determined by the location of the port on the sheet and the position of the connecting wire.

The CrossReference property returns the name of the sheet the port is linked to and the grid where the port is located at. Example : 4 Port Serial Interface [3C].

The ISch_Port hierarchy is as follows:
ISch_GraphicalObject
    ISch_ParametrizedGroup
        ISch_Port

ISch_Port methods
SetState_Name
SetState_Style
SetState_IOType
SetState_Alignment
SetState_TextColor
SetState_Width
SetState_CrossRef
SetState_UniqueId
SetState_ConnectedEnd
SetState_OverrideDisplayString
GetState_Name
GetState_Style
GetState_IOType
GetState_Alignment
GetState_TextColor
GetState_Width
GetState_CrossRef
GetState_UniqueId
GetState_ConnectedEnd
GetState_OverrideDisplayString
IsVertical
ISch_Port properties
Name
Style
IOType
Alignment
TextColor
Width
CrossReference
UniqueId
ConnectedEnd
OverrideDisplayString

See also
ISch_GraphicalObject interface
ISch_ParametrizedGroup interface

Methods

SetState_Width method

(ISch_Port interface)
Syntax
Procedure SetState_Width (AValue : TCoord);
Description
This SetState_Width procedure sets the width of the port object in a TCoord value. Use one of the following conversion functions to convert from a unit value to a TCoord value. For example MilsToCoord or DXPsToCoord functions.
Example
Port.SetState_Width(MilsToCoord(50));
See also
TCoord type.
Conversion functions
ISch_Port interface

SetState_UniqueId method

(ISch_Port interface)
Syntax
Procedure SetState_UniqueId (AValue : WideString);
Description
The SetState_UniqueID procedure sets the new ID for the port. All parameters, sheet symbols, ports, pins, components, openbus links, openbus ports and openbus components have Unique IDs. Unique IDs are used to maintain design synchronization in design projects.
The Unique ID (UID) is an system generated value that uniquely identifies this current port. It is used for linking to a PCB document and for project management. Enter a new UID value or click the Reset button to generate a new UID for this design object from the Change Properties dialog. You can also globally reset UIDs of components and sheet symbols from the Schematic Editor’s Tools » Convert » Reset Component Unique IDs menu.
Example

UID := WSM.DM_GenerateUniqueID; // interface and method from Workspace Manager API.
Port.SetState_UniqueID(UID);

See also
ISch_Port interface

SetState_TextColor method

(ISch_Port interface)
Syntax
Procedure SetState_TextColor (AValue : TColor);
Description
The SetState_TextColor procedure sets the color (a value of TColor type) for the Port’s Name string.
Notes
The TColor value specifies a 6 digit hexadecimal number of the $FFFFFF format.  For example the color blue would be RGB:0,0,255 and Hex:FF0000 therefore the converted decimal value would be 16711680.  The following formula may be used to calculate the required value, R+256*(G+(256*B)).
Example
Port.SetState_TextColor(0); // sets the text color to black.
See also
TColor type
ISch_Port interface

SetState_Style method

(ISch_Port interface)
Syntax
Procedure SetState_Style (AValue : TPortArrowStyle);
Description
The SetState_Style procedure sets the style of the port. This style is determined by the TPortArrowStyle type. This style defines the graphical style of the port.
Example
Port.SetState_Style(ePortLeft);
See also
TPortArrowStyle type
ISch_Port interface

SetState_Name method

(ISch_Port interface)
Syntax
Procedure SetState_Name (AValue : WideString);
Description
The SetState_Name procedure sets the new name for the Port object.
Example
Port.SetState_Name(‘Port Name’);
See also
ISch_Port interface

SetState_IOType method

(ISch_Port interface)
Syntax
Procedure SetState_IOType (AValue : TPortIO);
Description
The SetState_IOType procedure defines the electrical properties of the port with the TPortIO type. Available Port IO types are: Input, Output, Bi-directional and Unspecified.
The setting of this IO Type does not influence the connectivity of the circuit, but is considered during the running of an electrical rules check, which can be set to detect incompatible port directions.
Example
Port.SetState_IOType(ePortBidirectional);
See also
ISch_Port interface

SetState_CrossRef method

(ISch_Port interface)
Syntax
Procedure SetState_CrossRef (AValue : WideString);
Description
Example
See also
ISch_Port interface

SetState_ConnectedEnd method

(ISch_Port interface)
Syntax
Procedure SetState_ConnectedEnd(AValue : TPortConnectedEnd);
Description
The SetState_ConnectedEnd procedure sets the ConnectedEnd type of the port object which determines how the port is graphically connected.
Example
Port.SetState_ConenctedEnd(ePortConnectedEnd_Origin);
See also
TPortConnectedEnd;
ISch_Port interface

SetState_Alignment method

(ISch_Port interface)
Syntax
Procedure SetState_Alignment (AValue : THorizontalAlign);
Description
The SetState_Alignment function determines how the port’s Name is aligned with respect to the ends of the port itself. The Name string can be left justified, centered or right justified with respect to the port object.
Example
Port.SetState_Alignment(eHorizontalCentreAlign);
See also
THorizontalAlign type
ISch_Port interface

SetState_OverrideDisplayString method

(ISch_Port interface)
Syntax
Procedure SetState_OverrideDisplayString(AValue  : WideString);
Description
The SetState_OverrrideDisplayString function sets the override display string which overrides the Name string.
Example
Port.SetState_OverrideDisplayString(‘Override Name’);
See also
ISch_Port interface

GetState_Style method

(ISch_Port interface)
Syntax
Function GetState_Style : TPortArrowStyle;
Description
The GetState_Style procedure gets the style of the port. This style is determined by the TPortArrowStyle type. This style defines the graphical style of the port object.
Example
Port.GetState_Style(ePortLeft);
See also
TPortArrowStyle type
ISch_Port interface

GetState_Name method

(ISch_Port interface)
Syntax
Function GetState_Name : WideString;
Description
The GetState_Name procedure gets the name for the port object.
Example
PortName := Port.GetState_Name;
See also
ISch_Port interface

GetState_Width method

(ISch_Port interface)
Syntax
Function GetState_Width : TCoord;
Description
The GetState_Width function gets the width of the port in TCoord type. Use one of the following conversion functions to convert from a TCoord value to one of these Unit values. For example CoordToMils or CoordToDxps functions.
Example
Port.Width(DXPsToCoord(50));
See also
Conversion functions
ISch_Port interface

GetState_UniqueId method

(ISch_Port interface)
Syntax
Function GetState_UniqueId : WideString;
Description
The GetState_UniqueID procedure gets the ID for the port. All parameters, sheet symbols, ports, pins, components, openbus links, openbus ports and openbus components have Unique IDs. Unique IDs are used to maintain design synchronization in design projects.

The Unique ID (UID) is an system generated value that uniquely identifies this current port. It is used for linking to a PCB document and for project management. Enter a new UID value or click the Reset button to generate a new UID for this design object from the Change Properties dialog. You can also globally reset UIDs of components and sheet symbols from the Schematic Editor’s Tools » Convert » Reset Component Unique IDs menu.
Example
UID := Port.GetState_UniqueID;
See also
ISch_Port interface

GetState_TextColor method

(ISch_Port interface)
Syntax
Function GetState_TextColor : TColor;
Description
The GetState_TextColor procedure gets the color (a value of TColor type) from the Port’s Name string.
Notes
The TColor value specifies a 6 digit hexadecimal number of the $FFFFFF format.  For example the color blue would be RGB:0,0,255 and Hex:FF0000 therefore the converted decimal value would be 16711680.  The following formula may be used to calculate the required value, R+256*(G+(256*B)).
Example
Color := Port.GetState_TextColor;
See also
TColor type
ISch_Port interface

GetState_IOType method

(ISch_Port interface)
Syntax
Function GetState_IOType : TPortIO;
Description
The GetState_IOType function retrieves the electrical properties of the port of the TPortIO type. Available Port IO types are: Input, Output, Bi-directional and Unspecified.
The setting of this IO Type does not influence the connectivity of the circuit, but is considered during the running of an electrical rules check, which can be set to detect incompatible port directions.
Example
IOType := Port.GetState_IOType;
See also
ISch_Port interface

GetState_CrossRef method

(ISch_Port interface)
Syntax
Function GetState_CrossRef : WideString;
Description
The GetState_CrossRef function returns the text of the parameter associated with the port. The Parameter has a Name of ‘CrossRef’.
Example
See also
ISch_Port interface

GetState_ConnectedEnd method

(ISch_Port interface)
Syntax
Function GetState_ConnectedEnd : TPortConnectedEnd;
Description
The GetState_ConnectedEnd procedure gets the ConnectedEnd type of the port object which determines how the port is graphically connected.
Example
ConnectedEnd := Port.GetState_ConnectedEnd;
See also
ISch_Port interface

GetState_Alignment method

(ISch_Port interface)
Syntax
Function GetState_Alignment : THorizontalAlign;
Description
The GetState_Alignment function determines how the port’s Name is aligned with respect to the ends of the port itself. The Name string can be left justified, centered or right justified in respect to the port object.
Example
Align := Port.GetState_Alignment;
See also
ISch_Port interface

GetState_OverrideDisplayString method

(ISch_Port interface)
Syntax
Function  GetState_OverrideDisplayString : WideString;
Description
The GetState_OverrrideDisplayString function returns the override display string which overrides the Name string.
Example
DisplayString := Port.GetState_OverrideDisplayString;
See also
ISch_Port interface

IsVertical method

(ISch_Port interface)
Syntax
Function IsVertical : Boolean;
Description
This function returns a Boolean value that determines whether the port object is aligned vertically or not.
Example
Vertical := Port.IsVertical;
See also
ISch_Port interface

Properties

Width property

(ISch_Port interface)
Syntax
Property Width : TCoord Read GetState_Width Write SetState_Width ;
Description
Example
See also
ISch_Port interface

UniqueId property

(ISch_Port interface)
Syntax
Property UniqueId : WideString Read GetState_UniqueId Write SetState_UniqueId ;
Description
The UniqueID property sets the new ID for the port. All parameters, sheet symbols, ports, pins, components, openbus links, openbus ports and openbus components have Unique IDs. Unique IDs are used to maintain design synchronization in design projects.

The Unique ID (UID) is an system generated value that uniquely identifies this current port. It is used for linking to a PCB document and for project management. Enter a new UID value or click the Reset button to generate a new UID for this design object from the Change Properties dialog. You can also globally reset UIDs of components and sheet symbols from the Schematic Editor’s Tools » Convert » Reset Component Unique IDs menu.
Example

UID := WSM.DM_GenerateUniqueID; // interface and method from Workspace Manager API.
Port.UniqueID(UID);

See also
ISch_Port interface

TextColor property

(ISch_Port interface)
Syntax
Property TextColor : TColor Read GetState_TextColor Write SetState_TextColor;
Description
The TextColor property determines the color (a value of TColor type) of the Port’s Name string. This property is supported by the GetState_TextColor and SetState_TextColor methods.
Notes
The TColor value specifies a 6 digit hexadecimal number of the $FFFFFF format.  For example the color blue would be RGB:0,0,255 and Hex:FF0000 therefore the converted decimal value would be 16711680.  The following formula may be used to calculate the required value, R+256*(G+(256*B)).
Example
Color := Port.TextColor;
See also
TColor type
ISch_Port interface

Style property

(ISch_Port interface)
Syntax
Property Style : TPortArrowStyle Read GetState_Style Write SetState_Style ;
Description
The Style property determines the style of the port object. This style is determined by the TPortArrowStyle type. This style defines the graphical style of the port object.
Example
Port.Style := ePortLeft;
See also
TPortArrowStyle type
ISch_Port interface

Name property

(ISch_Port interface)
Syntax
Property Name : WideString Read GetState_Name Write SetState_Name ;
Description
The Name property determines the name for the port object. This property is supported by the GetState_Name and SetState_Name methods.
Example
PortName := Port.Name;
See also
ISch_Port interface

IOType property

(ISch_Port interface)
Syntax
Property IOType : TPortIO Read GetState_IOType Write SetState_IOType ;
Description
The IOType property defines the electrical properties of the port with the TPortIO type. Available Port IO types are: Input, Output, Bi-directional and Unspecified.
The setting of this IO Type does not influence the connectivity of the circuit, but is considered during the running of an electrical rules check, which can be set to detect incompatible port directions.
Example
PortIOType := Port.IOType;
See also
TPortIO type
ISch_Port interface

CrossReference property

(ISch_Port interface)
Syntax
Property CrossReference : WideString Read GetState_CrossRef Write SetState_CrossRef ;
Description
Port Cross References are text that show which schematic sheets the ports are linked to with the zone reference information in brackets. For example a port with A[0..2] name on 4 Port UART and Line Drivers.SchDoc will have a string with "ISA and Address Decoding[4C]" and the 4C string represents the location (reference zone markers around the schematic sheet) of the matching port on ISA and Address Decoding.SchDoc. The string in the [] bracket is dependent on the Port Cross References options in the Schematic - General page of the Preferences dialog.

Port Cross References are generated from the Reports » Port Cross Reference » Add to Sheet or Reports » Port Cross Reference » Add to Project commands in the Schematic Editor.

The CrossReference property is supported by the GetState_CrossRef and SetState_CrossRef methods. The CrossRef string is also represented as a parameter associated with this port object AFTER the port cross reference command from the Reports menu has been invoked.
Example

Var
    Port         : ISch_Port;
    CurrentSheet : ISch_Document;
    Iterator     : ISch_Iterator;
    Report         : TStringList;
    ReportDocument : IServerDocument;
    S              : WideString;
Begin
    // Obtain the current schematic sheet interface.
    CurrentSheet := SchServer.GetCurrentSchDocument;
    If CurrentSheet = Nil Then Exit;
 
    Report := TStringList.Create;
    Iterator := CurrentSheet.SchIterator_Create;
    Iterator.AddFilter_ObjectSet(MkSet(ePort));
 
    Try
        Port := Iterator.FirstSchObject;
        While Port <> Nil Do
        Begin
            If Port.Getstate_CrossRef <> '' Then
                Report.Add('Port:' + Port.Name + '''s cross reference: ' + Port.GetState_CrossRef)
            Else
                Report.Add('Port:' + Port.Name + ' does not have a cross reference.');
 
            Port := Iterator.NextSchObject;
        End;
    Finally
        CurrentSheet.SchIterator_Destroy(Iterator);
    End;
 
    S := 'C:\PortReport.Txt';
    Report.SaveToFile(S);
    Report.Free;
 
    ReportDocument := Client.OpenDocument('Text', S);
    If ReportDocument <> Nil Then
        Client.ShowDocument(ReportDocument);
End;

See also
ISch_Port interface
GetState_CrossRef and SetState_CrossRef methods of ISch_Port interface.

ConnectedEnd property

(ISch_Port interface)
Syntax
Property ConnectedEnd : TPortConnectedEnd Read GetState_ConnectedEnd Write SetState_ConnectedEnd;
Description
The ConnectedEnd property determines how a port object is connected graphically with the TPortConnectedEnd type. This property is supported by the GetState_ConnectedEnd and SetState_ConnectedEnd methods.
Example
Port.ConnectedEnd := ePortConnectedEnd_Extremity; // connected at the other end
See also
TPortConnectedEnd type
ISch_Port interface

Alignment property

(ISch_Port interface)
Syntax
Property Alignment : THorizontalAlign Read GetState_Alignment Write SetState_Alignment;
Description
The Alignment property determines how the port’s Name is aligned with respect to the ends of the port itself. The Name string can be left justified, centered or right justified. This property is supported by the GetState_Alignment and SetState_Alignment methods.
Example
Port.Alignment := eHorizontalCentreAlign;
See also
THorizontalAlign type
ISch_Port interface

OverrideDisplayString property

(ISch_Port interface)
Syntax
Property OverrideDisplayString : WideString        Read GetState_OverrideDisplayString Write SetState_OverrideDisplayString;
    End;
Description
The OverrrideDisplayString property determines the override display string which overrides the Name string. This property is supported by the GetState_OverrideDisplayString and SetState_OverrideDisplayString methoes.
Example
DisplayString := SheetEntry.GetState_OverrideDisplayString;
See also
ISch_Port interface

ISch_PowerObject Interface

Overview
Power ports are special symbols that represent a power supply and are always identified by their net names.  The Text property is the net name of the power object.
Notes
The ISch_PowerObject interface hierarchy is as follows:
ISch_GraphicalObject
    ISch_Label
        ISch_PowerObject

ISch_PowerObject methods
SetState_Style
GetState_Style
SetState_ShowNetName
GetState_ShowNetName
ISch_PowerObject properties
Style
ShowNetName

See also
ISch_GraphicalObject interface
ISch_Label interface

Methods

SetState_ShowNetName method

(ISch_PowerObject interface)
Syntax
Procedure SetState_ShowNetName(AValue : Boolean)
Description
Example
See also
ISch_PowerObject interface

SetState_Style method

(ISch_PowerObject interface)
Syntax
Procedure SetState_Style(AStyle : TPowerObjectStyle);
Description
The SetState_Style procedure sets the style of the power object. This style is determined by the TPowerObjectStyle type. This style defines the graphical style of the power object. Available styles are: Circle, Arrow, Wave, Bar, Power Ground, Signal Ground and Earth. Note: The graphical style of a power object has no influence on the net to which it is assigned and does not define any electrical characteristics of the object.
Example
PowerObject.SetState_Style(ePowerGndEarth);
See also
ISch_PowerObject interface

GetState_Style method

(ISch_PowerObject interface)
Syntax
Function GetState_Style : TPowerObjectStyle;
Description
The GetState_Style function gets the style of the power object. This style is determined by the TPowerObjectStyle type. This style defines the graphical style of the power object. Available styles are: Circle, Arrow, Wave, Bar, Power Ground, Signal Ground and Earth. Note: The graphical style of a power object has no influence on the net to which it is assigned and does not define any electrical characteristics of the object.
Example
PowerStyle := PowerObject.GetState_Style;
See also
TPowerObjectStyle type
ISch_PowerObject interface

GetState_ShowNetName method

(ISch_PowerObject interface)
Syntax
Function  GetState_ShowNetName        : Boolean;
Description
Example
See also
ISch_PowerObject interface

Properties

Style property

(ISch_PowerObject interface)
Syntax
Property Style : TPowerObjectStyle Read GetState_Style Write SetState_Style;
Description
This property denotes the style of the power object. This property is supported by the GetState_Style and SetState_Style methods.
Example
See also
ISch_PowerObject interface
TPowerObjectStyle type

ShowNetName property

(ISch_PowerObject interface)
Syntax
Property ShowNetName : Boolean Read GetState_ShowNetName Write SetState_ShowNetName;
Description
This property denotes the visibility of the net name of the power object. This property is supported by the GetState_ShowNetName and SetState_ShowNetName methods.
Example
See also
ISch_PowerObject interface
TPowerObjectStyle type

ISch_Probe Interface

Overview
A probe is a special marker which is placed on a schematic document to identify nodes for digital simulation.
Notes
The ISch_Probe interface hierarchy is as follows:
ISch_GraphicalObject
    ISch_ParametrizedGroup
        ISch_ParameterSet
            ISch_Probe

ISch_Probe methods ISch_Probe properties

See also
ISch_GraphicalObject interface
ISch_ParametrizedGroup interface
ISch_ParameterSet interface

ISch_Rectangle Interface

Overview
Rectangles are drawing objects which are unfilled or filled graphic elements.
Notes
The ISch_Rectangle interface hierarchy is as follows:
ISch_GraphicalObject interface
    ISch_Rectangle interface

ISch_Rectangle methods
SetState_Corner
SetState_LineWidth
SetState_IsSolid
SetState_Transparent
GetState_Corner
GetState_LineWidth
GetState_IsSolid
GetState_Transparent
ISch_Rectangle properties
Corner
LineWidth
IsSolid
Transparent

See also
ISch_GraphicalObject interface

Methods

SetState_Transparent method

(ISch_Rectangle interface)
Syntax
Procedure SetState_Transparent(B : Boolean);
Description
Example
See also
ISch_Rectangle interface

SetState_LineWidth method

(ISch_Rectangle interface)
Syntax
Procedure SetState_LineWidth (ASize : TSize);
Description
The SetState_LineWidth procedure sets the line width for the border of the rectangle object. The Line width is determined by the TSize type.
Example
Rectangle.SetState_LineWidth(eSmall);
See also
TSize type.
ISch_Rectangle interface

SetState_IsSolid method

(ISch_Rectangle interface)
Syntax
Procedure SetState_IsSolid (B : Boolean);
Description
Example
See also
ISch_Rectangle interface

SetState_Corner method

(ISch_Rectangle interface)
Syntax
Procedure SetState_Corner (ALocation : TLocation);
Description
Example
See also
ISch_Rectangle interface

GetState_Transparent method

(ISch_Rectangle interface)
Syntax
Function GetState_Transparent : Boolean;
Description
Example
See also
ISch_Rectangle interface

GetState_LineWidth method

(ISch_Rectangle interface)
Syntax
Function GetState_LineWidth : TSize;
Description
The GetState_LineWidth function returns the line width of the rectangle’s border. The line width is determined by the TSize type.
Example
Width := Rectangle.GetState_LineWidth;
See also
TSize type.
ISch_Rectangle interface

GetState_IsSolid method

(ISch_Rectangle interface)
Syntax
Function GetState_IsSolid : Boolean;
Description
Example
See also
ISch_Rectangle interface

GetState_Corner method

(ISch_Rectangle interface)
Syntax
Function GetState_Corner : TLocation;
Description
Example
See also
ISch_Rectangle interface

Properties

LineWidth property

(ISch_Rectangle interface)
Syntax
Property LineWidth : TSize Read GetState_LineWidth Write SetState_LineWidth;
Description
The LineWidth property defines the border width of the rectangle with one of the following values from the TSize enumerated type. This property is supported by the GetState_LineWidth and SetState_LineWidth methods.
Example
Rect.LineWidth := eSmall;
See also
TSize type.
ISch_Rectangle interface

IsSolid property

(ISch_Rectangle interface)
Syntax
Property IsSolid : Boolean Read GetState_IsSolid Write SetState_IsSolid;
Description
Example
See also
ISch_Rectangle interface

Corner property

(ISch_Rectangle interface)
Syntax
Property Corner : TLocation Read GetState_Corner Write SetState_Corner;
Description
Example
See also
ISch_Rectangle interface

Transparent property

(ISch_Rectangle interface)
Syntax
Property Transparent : Boolean Read GetState_Transparent Write SetState_Transparent;
Description
Example
See also
ISch_Rectangle interface

ISch_RectangularGroup Interface

Overview
The ISch_RectangularGroup interface represents a group rectangular object with the size of the object with XSize and YSize dimensions. The Origin of the rectangular object is the Location property from the ISch_GraphicalObject interface. 

The ISch_RectangularGroup interface is an ancestor interface for the ISch_SheetSymbol, ISch_HarnessConnector and IOpenBus_Component interfaces.
Notes
The interface hierarchy for the ISch_RectangularGroup interface is as follows:
ISch_GraphicalObject
    ISch_ParametrizedGroup
        ISch_RectangularGroup

ISch_RectangularGroup methods
SetState_XSize
SetState_YSize
GetState_XSize
GetState_YSize
ISch_RectangularGroup properties
XSize
YSize

See also
ISch_GraphicalObject interface
ISch_ParametrizedGroup interface
IOpenBus_Component interface
ISch_HarnessConnector interface
ISch_SheetSymbol interface

Methods

SetState_YSize method

(ISch_RectangularGroup interface)
Syntax
Procedure SetState_YSize(Value : TCoord);
Description
This function sets the YSize dimension of the rectangular group object such as the sheet symbol.
Example

SheetSymbol.SetState_XSize(MilsToCoord(150));
SheetSymbol.SetState_YSize(MilsToCoord(50));

See also
SetState_XSize method
ISch_RectangularGroup interface

SetState_XSize method

(ISch_RectangularGroup interface)
Syntax
Procedure SetState_XSize(Value : TCoord);
Description
This function sets the XSize dimension of the rectangular group object such as the sheet symbol.
Example

SheetSymbol.SetState_XSize(MilsToCoord(150));
SheetSymbol.SetState_YSize(MilsToCoord(50));

See also
GetState_YSize method
ISch_RectangularGroup interface

GetState_YSize method

(ISch_RectangularGroup interface)
Syntax
Function GetState_YSize : TCoord;
Description
This function retrieves the YSize dimension of the rectangular group object such as the sheet symbol. THis function is used by the YSize property.
Example

AXSize := SheetSymbol.SetState_XSize;
AYSize := SheetSymbol.SetState_YSize;

See also
GetState_YSize method
ISch_RectangularGroup interface

GetState_XSize method

(ISch_RectangularGroup interface)
Syntax
Function GetState_XSize : TCoord;
Description
This function retrieves the XSize dimension of the rectangular group object such as the sheet symbol. THis function is used by the XSize property.
Example

AXSize := SheetSymbol.SetState_XSize;
AYSize := SheetSymbol.SetState_YSize;

See also
ISch_RectangularGroup interface

Properties

YSize property

(ISch_RectangularGroup interface)
Syntax
Property YSize : TCoord Read GetState_YSize Write SetState_YSize;
Description
Example

SheetSymbol.SetState_XSize(MilsToCoord(150));
SheetSymbol.SetState_YSize(MilsToCoord(50));

See also
ISch_RectangularGroup interface

XSize property

(ISch_RectangularGroup interface)
Syntax
Property XSize : TCoord Read GetState_XSize Write SetState_XSize;
Description
The XSize property sets or gets the XSize dimension of the rectangular group object such as a sheet symbol. The XSize and YSize values determines the size of the rectangular group object in the X and Y directions.
The Location property from the ISch_GraphicalObject interface determines the origin of the rectangular group object.
Example

SheetSymbol.XSize := MilsToCoord(150);
SheetSymbol.YSize := MilsToCoord(50);

See also
SetState_XSize method
SetState_YSize method
ISch_RectangularGroup interface

ISch_RoundRectangle Interface

Overview
Rounded rectangles are drawing objects which are unfilled or filled graphic elements.
Notes
The ISch_RoundRectangle interface hierarchy is as follows:
ISch_GraphicalObject
    ISch_Rectangle
        ISch_RoundRectangle

ISch_RoundRectangle methods
SetState_CornerXRadius
SetState_CornerYRadius
GetState_CornerXRadius
GetState_CornerYRadius
ISch_RoundRectangle properties
CornerXRadius
CornerYRadius

Methods

SetState_CornerXRadius method

(ISch_RoundRectangle interface)
Syntax
Procedure SetState_CornerXRadius(ADistance : TDistance);
Description
Example
See also
ISch_RoundRectangle interface

GetState_CornerYRadius method

(ISch_RoundRectangle interface)
Syntax
Function GetState_CornerYRadius : TDistance;
Description
Example
See also
ISch_RoundRectangle interface

GetState_CornerXRadius method

(ISch_RoundRectangle interface)
Syntax
Function GetState_CornerXRadius : TDistance;
Description
Example
See also
ISch_RoundRectangle interface

SetState_CornerYRadius method

(ISch_RoundRectangle interface)
Syntax
Procedure SetState_CornerYRadius(ADistance : TDistance);
Description
Example
See also
ISch_RoundRectangle interface
See also
ISch_GraphicalObject interface
ISch_Rectangle interface

Properties

CornerYRadius property

(ISch_RoundRectangle interface)
Syntax
Property CornerYRadius : TDistance Read GetState_CornerYRadius Write SetState_CornerYRadius;
Description
Example
See also
ISch_RoundRectangle interface

CornerXRadius property

(ISch_RoundRectangle interface)
Syntax
Property CornerXRadius : TDistance Read GetState_CornerXRadius Write SetState_CornerXRadius;
Description
Example
See also
ISch_RoundRectangle interface

ISch_SheetEntry Interface

Overview
A sheet entry within a Sheet Symbol object creates a connection between the net touching on the parent sheet, to a Port with the same name on the child sheet.
Notes
The ISch_SheetEntry interface hierarchy is as follows:
ISch_GraphicalObject
    ISch_SheetEntry

ISch_SheetEntry methods
GetState_DistanceFromTop
GetState_IOType
GetState_Name
GetState_OverrideDisplayString
GetState_OwnerSchSheetSymbol
GetState_OwnerSchSheetSymbol
GetState_Side
GetState_Style
GetState_TextColor
SetState_DistanceFromTop
SetState_IOType
SetState_Name
SetState_OverrideDisplayString
SetState_Side
SetState_Style
SetState_TextColor
IsVertical
ISch_SheetEntry properties
DistanceFromTop
IOType
Name
OverrideDisplayString
OwnerSheetSymbol
Side
Style
TextColor

See also
ISch_SheetEntry interface

Methods

SetState_Style method

(ISch_SheetEntry interface)
Syntax
Procedure SetState_Style (Value : TPortArrowStyle);
Description
The SetState_Style procedure sets the style of the sheet entry. This style is determined by the TPortArrowStyle type. This style defines the graphical style of the sheet entry only if the I/O Type property is set to Unspecified. The IO Type of the Sheet Entry overrides the Style property if the I/O Type is set to one of the specified IO types then changing the Style will not update the graphical content of the sheet entry.
Example
SEntry.SetState_Style(ePortLeft);
See also
TPortArrowStyle type
ISch_SheetEntry interface

SetState_Side method

(ISch_SheetEntry interface)
Syntax
Procedure SetState_Side(Value : TLeftRightSide);
Description
The SetState_Side procedure sets the orientation of the sheet entry in respect to the associated Sheet symbol.
Example
SheetEntry.SetState_Side(eLeftSide);
See also
TLeftRightSide type.
ISch_SheetEntry interface.

SetState_Name method

(ISch_SheetEntry interface)
Syntax
Procedure SetState_Name(Value : WideString);
Description
The SetState_Name procedure sets the new name for the Sheet Entry.
Example
SheetEntry.SetState_Name(‘HarnessType2’);
See also
ISch_SheetEntry interface

SetState_DistanceFromTop method

(ISch_SheetEntry interface)
Syntax
Procedure SetState_DistanceFromTop(Value : TCoord);
Description
The SetState_DistanceFromTop function sets the distance from this sheet entry to the top edge of the sheet symbol in a value that’s dependent on the grid units. For example if the grid was in DXP Defaults (10 DXP units = 100 mils for example) and the Entry is 10 Units away from the Top part of the Sheet Symbol then you would use the DxpToCoords function to translate the 10 grid units into a coordinate value.
Example
SheetEntry.SetState_DistanceFromTop(DxpsToCoord(10));
See also
DXPsToCoord function
Measurement Conversion functions
ISch_SheetEntry interface

SetState_TextColor method

(ISch_SheetEntry interface)
Syntax
Procedure SetState_TextColor(Value : TColor);
Description
The SetState_TextColor procedure sets the color (a value of TColor type) for the Sheet Entry’s Name string.
Notes
The TColor value specifies a 6 digit hexadecimal number of the $FFFFFF format.  For example the color blue would be RGB:0,0,255 and Hex:FF0000 therefore the converted decimal value would be 16711680.  The following formula may be used to calculate the required value, R+256*(G+(256*B)).
Example
SheetEntry.SetState_TextColor(0); // sets the text color to black.
See also
TColor type
ISch_SheetEntry interface

SetState_IOType method

(ISch_SheetEntry interface)
Syntax
Procedure SetState_IOType (Value : TPortIO);
Description
The SetState_IOType procedure sets the IO of the sheet entry. This IO Type defines the electrical properties of the sheet entry. Available IOs are: Input, Output, Bi-directional and Unspecified. The IO setting does not influence the connectivity of the circuit, but is considered during the running of an electrical rules check, which can be set to detect incompatible port directions.

Note, the I/O Type of the Sheet Entry overrides the Style property. If the I/O Type is set to Unspecified you can set the appropriate Style for this sheet entry. However if the I/O Type is set to one of the specified I/O types then changing the Style will not update the graphical content of the sheet entry.
Example
SheetEntry.SetStateIOType(ePortBidirectional);
See also
IPortIO type
ISch_SheetEntry interface

SetState_OverrideDisplayString method

(ISch_SheetEntry interface)
Syntax
Procedure SetState_OverrideDisplayString(Value : WideString );
Description
The SetState_OverrideDisplayString procedure sets a new value consisting of alph-numeric characters for the Override Display string.
Example
SheetEntry.SetState_OverrideDisplayString(‘New Override String’);
See also
ISch_HarnessEntry interface

GetState_TextColor method

(ISch_SheetEntry interface)
Syntax
Function GetState_TextColor : TColor;
Description
The GetState_TextColor function returns the color of the text used for the Name of the Sheet Entry.
Example
Color := SheetEntry.GetState_TextColor;
See also
TColor type
ISch_SheetEntry

GetState_Style method

(ISch_SheetEntry interface)
Syntax
Function GetState_Style : TPortArrowStyle;
Description
The GetState_Style function gets the style of the sheet entry. This style is determined by the TPortArrowStyle type. This style defines the graphical style of the sheet entry only if the I/O Type property is set to Unspecified. The IO Type of the Sheet Entry overrides the Style property if the I/O Type is set to one of the specified IO types then changing the Style will not update the graphical content of the sheet entry.
Example
Style := SEntry.GetState_Style;
See also
TPortArrowStyle type.
ISch_SheetEntry interface

GetState_Side method

(ISch_SheetEntry interface)
Syntax
Function GetState_Side : TLeftRightSide;
Description
The GetState_Side function returns the orientation of the sheet entry in respect to the associated sheet symbol as a TLeftRightSide type.
Example
Side := SheetEntry.GetState_Side;
See also
TLeftRightSide type
ISch_SheetEntry interface

GetState_SchOwnerSheetSymbol method

(ISch_SheetEntry interface)
Syntax
Function GetState_SchOwnerSheetSymbol : ISch_SheetSymbol;
Description
The GetState_SchOwnerSheetSymbol function returns the sheet symbol interface (ISch_Sheet Symbol) that this sheet entry is associated with.
Example
OwnerSheetSymbol := SheetEntry.GetState_SchOwnerSheetSymbol;
See also
ISch_SheetEntry interface
ISch_SheetSymbol interface

GetState_Name method

(ISch_SheetEntry interface)
Syntax
Function GetState_Name : WideString;
Description
The GetState_Name function returns the name of the sheet entry. Normally the name is a number but can be alphanumeric.
Example
EntryName := SheetEntry.GetStateName
See also
Name property.
ISch_SheetEntry interface

GetState_IOType method

(ISch_SheetEntry interface)
Syntax
Function GetState_IOType : TPortIO;
Description
The GetState_IOType procedure gets the IO type of the sheet entry. This IO Type defines the electrical properties of the sheet entry. Available IOs are: Input, Output, Bi-directional and Unspecified. The IO setting does not influence the connectivity of the circuit, but is considered during the running of an electrical rules check, which can be set to detect incompatible port directions.

Note, the I/O Type of the Sheet Entry overrides the Style property. If the I/O Type is set to Unspecified you can set the appropriate Style for this sheet entry. However if the I/O Type is set to one of the specified I/O types then changing the Style will not update the graphical content of the sheet entry.
Example
IOType := SheetEntry.GetState_IOType;
See also
TPortIO type
ISch_SheetEntry interface

GetState_DistanceFromTop method

(ISch_SheetEntry interface)
Syntax
Function  GetState_DistanceFromTop : TCoord;
Description
The GetState_DistanceFromTop function returns the distance from this sheet entry to the top edge of the sheet symbol in a value that’s dependent on the grid units. For example if the grid was in DXP Defaults (10 DXP units = 100 mils for example) and the Entry is 10 Units away from the Top part of the Sheet Symbol.
Example
Distance := SheetEntry.GetState_DistanceFromTop;
See also
ISch_SheetEntry interface
ISch_SheetSymbol interface.

GetState_OverrideDisplayString method

(ISch_SheetEntry interface)
Syntax
Function  GetState_OverrideDisplayString : WideString;
Description
The GetState_OverrrideDisplayString function returns the override display string which overrides the Name string.
Example
DisplayString := SheetEntry.GetState_OverrideDisplayString;
See also
ISch_SheetEntry interface

IsVertical method

(ISch_SheetEntry interface)
Syntax
Function IsVertical : Boolean;
Description
This function returns a Boolean value that determines whether the sheet entry is aligned vertically or not.
Example
Vertical := SheetEntry.IsVertical;
See also
ISch_SheetEntry interface

Properties

TextColor

(ISch_SheetEntry interface)
Syntax
Property TextColor : TColor Read GetState_TextColor Write SetState_TextColor;
Description
The TextColor property defines the color (a value of TColor type) for the Harness Entry’s Name string. This property is supported by the GetState_TextColor and SetState_TextColor methods.
Notes
The TColor value specifies a 6 digit hexadecimal number of the $FFFFFF format.  For example the color blue would be RGB:0,0,255 and Hex:FF0000 therefore the converted decimal value would be 16711680.  The following formula may be used to calculate the required value, R+256*(G+(256*B)).
Example
SheetEntry.TextColor := 0; // sets the name color to black.
See also
TColor type
ISch_SheetEntry interface

Style property

(ISch_SheetEntry interface)
Syntax
Property Style : TPortArrowStyle Read GetState_Style Write SetState_Style;
Description
The Style property determines the style of the sheet entry and is determined by the TPortArrowStyle type. This style defines the graphical style of the sheet entry only if the I/O Type property is set to Unspecified. The IO Type of the Sheet Entry overrides the Style property if the I/O Type is set to one of the specified IO types then changing the Style will not update the graphical content of the sheet entry.
Example
SEntry.Style := ePortLeft;
See also
TPortArrowStyle type
ISch_SheetEntry interface

Side

(ISch_SheetEntry interface)
Syntax
Property Side : TLeftRightSide Read GetState_Side Write SetState_Side;
Description
The Side property defines the orientation of the sheet entry in respect to the associated sheet symbol. This property is supported by the GetState_Side and SetState_Side methods.
Example
SheetEntry.Side := eLeftSide;
See also
ISch_SheetEntry interface

OwnerSheetSymbol property

(ISch_SheetEntry interface)
Syntax
Property OwnerSheetSymbol : ISch_SheetSymbol Read GetState_SchOwnerSheetSymbol;
Description
The OwnerSheetSymbol property retrieves the Sheet Symbol interface this Sheet entry is associated with. This property is supported by the GetState_OwnerSheetSymbol method.
Example
SheetSymbol := SheetEntry.GetState_OwnerSheetSymbol;
See also
ISch_SheetEntry interface

Name

(ISch_SheetEntry interface)
Syntax
Property Name : WideString Read GetState_Name Write SetState_Name;
Description
The Name property defines the name of the sheet entry. Normally the name property is a number but can be alphanumeric. This property is supported by the GetState_Name and SetState_Name methods.
Example
SheetEntry.Name := ‘EntryType_2’;
See also
ISch_SheetEntry interface

IOType property

(ISch_SheetEntry interface)
Syntax
Property IOType : TPortIO Read GetState_IOType Write SetState_IOType;
Description
The IOType property determines the IO of the sheet entry. This IO Type defines the electrical properties of the sheet entry. Available IOs are: Input, Output, Bi-directional and Unspecified. The IO setting does not influence the connectivity of the circuit, but is considered during the running of an electrical rules check, which can be set to detect incompatible port directions.

Note, the I/O Type of the Sheet Entry overrides the Style property. If the I/O Type is set to Unspecified you can set the appropriate Style for this sheet entry. However if the I/O Type is set to one of the specified I/O types then changing the Style will not update the graphical content of the sheet entry.
Example
SheetEntry.IOType := ePortOutput;
See also
ISch_SheetEntry interface

DistanceFromTop

(ISch_SheetEntry interface)
Syntax
Property DistanceFromTop : TCoord Read GetState_DistanceFromTop Write SetState_DistanceFromTop;
Description
The DistanceFromTop property defines the location of the sheet entry in respect to the associated sheet symbol. This property is supported by the GetState_DistanceFromTop and SetState_DistanceFromTop methods.
Example
SheetEntry.DistanceFromTop := DxpsToCoord(10);
See also
ISch_SheetEntry interface

OverrideDisplayString property

(ISch_SheetEntry interface)
Syntax
Property OverrideDisplayString : WideString Read GetState_OverrideDisplayString Write SetState_OverrideDisplayString;
Description
The OverrideDisplayString property defines the OverRideDisplayString property. This property is supported by the GetState_OverrirdeDisplayString and SetState_OverrirdeDisplayString methods.
Example
SheetEntry.OverrideDisplayString(‘Display String overridden.’);
See also
ISch_SheetEntry interface

ISch_SheetFileName Interface

Overview
A sheet filename object is part of a complex text object interface and is attached to the sheet symbol object.
Notes
The ISch_SheetFileName interface hierarchy is as follows:
ISch_GraphicalObject
    ISch_Label
        ISch_ComplexText
            ISch_SheetFileName

ISch_SheetFileName methods ISch_SheetFileName properties

See also
ISch_GraphicalObject interface
ISch_Label interface
ISch_ComplexText interface

ISch_SheetName Interface

Overview
A sheetname is part of a complex text object interface and is associated with a sheet symbol object.
Notes
The ISch_SheetName interface hierarchy is as follows:
ISch_GraphicalObject
    ISch_Label
        ISch_ComplexText
            ISch_SheetName

ISch_SheetName methods ISch_SheetName properties

See also
ISch_GraphicalObject interface
ISch_Label interface
ISch_ComplexText interface

ISch_SheetSymbol Interface

Overview
Sheet symbols represent other schematic sheets (often referred to as a child sheet).  The link between a sheet symbol and other schematic sheets is the FileName attribute, which must be the same as the name of the child sheet.
Notes
The ISch_SheetSymbol interface hierarchy is as follows:
ISch_GraphicalObject
    ISch_ParametrizedGroup
        ISch_RectangularGroup
            ISch_SheetSymbol

ISch_SheetSymbol methods
SetState_UniqueId
SetState_LineWidth
SetState_IsSolid
SetState_ShowHiddenFields
GetState_UniqueId
GetState_LineWidth
GetState_IsSolid
GetState_ShowHiddenFields
GetState_SchSheetFileName
GetState_SchSheetName
ISch_SheetSymbol properties
UniqueId
LineWidth
IsSolid
ShowHiddenFields
SheetFileName
SheetName

See also
ISch_GraphicalObject interface
ISch_ParametrizedGroup interface
ISch_RectangularGroup interface

Methods

SetState_UniqueId method

(ISch_SheetSymbol interface)
Syntax
Procedure SetState_UniqueId (Value : WideString);
Description
The SetState_UniqueID procedure sets the new ID for the sheet symbol. All parameters, sheet symbols, ports, pins, components, openbus links, openbus ports and openbus components have Unique IDs. Unique IDs are used to maintain design synchronization in design projects.

The Unique ID (UID) is an system generated value that uniquely identifies this current sheet symbol. It is used for linking to a PCB document and for project management. Enter a new UID value or click the Reset button to generate a new UID for this design object from the Change Properties dialog. You can also globally reset UIDs of components and sheet symbols from the Schematic Editor’s Tools » Convert » Reset Component Unique IDs menu.
Example

UID := WSM.DM_GenerateUniqueID; // interface and method from Workspace Manager API.
SheetSymbol.SetState_UniqueID(UID);

See also
ISch_SheetSymbol interface

SetState_ShowHiddenFields method

(ISch_SheetSymbol interface)
Syntax
Procedure SetState_ShowHiddenFields(Value : Boolean);
Description
The SetState_ShowHiddenFields procedure determines the visibility of the text fields associated with the sheet symbol, such as its name and filename. If the Value is true, the hidden fields of the sheet symbol will be displayed on the schematic sheet. If the value is False, the hidden text fields are not shown on the schematic.
Example
SSheet.SetState_ShowHiddenFields(True); //shows hidden text fields for this sheet symbol.
See also
ISch_SheetSymbol interface

SetState_LineWidth method

(ISch_SheetSymbol interface)
Syntax
Procedure SetState_LineWidth (Value : TSize);
Description
This SetState_LineWidth procedure sets the width of the border line around the sheet symbol. The width is determined by the TSize type.
Example
SSheet.SetState_LineWidth(eSmall);
See also
TSize type.
ISch_SheetSymbol interface

SetState_IsSolid method

(ISch_SheetSymbol interface)
Syntax
Procedure SetState_IsSolid (Value : Boolean);
Description
The SetState_IsSolid procedure sets a Boolean value which denotes that the sheet symbol object has a solid internal fill or not.
Example

SSymbol.SetState_IsSolid(True);
SSymbol.AreaColor := 0;

See also
ISch_SheetSymbol interface

GetState_UniqueId method

(ISch_SheetSymbol interface)
Syntax
Function GetState_UniqueId : WideString;
Description
The GetState_UniqueID function retrieves the Unique ID for the sheet symbol. All parameters, sheet symbols, ports, pins, components, openbus links, openbus ports and openbus components have Unique IDs. Unique IDs are used to maintain design synchronization in design projects.

The Unique ID (UID) is an system generated value that uniquely identifies this current sheet symbol. It is used for linking to a PCB document and for project management. Enter a new UID value or click the Reset button to generate a new UID for this design object from the Change Properties dialog. You can also globally reset UIDs of components and sheet symbols from the Schematic Editor’s Tools » Convert » Reset Component Unique IDs menu.
Example
UID := SheetSymbol.GetState_UniqueID;
See also
ISch_SheetSymbol interface

GetState_ShowHiddenFields method

(ISch_SheetSymbol interface)
Syntax
Function GetState_ShowHiddenFields : Boolean;
Description
The GetState_ShowHiddenFields procedure determines the visibility of the text fields associated with the sheet symbol, such as its name and filename. If the Value is true, the hidden fields of the sheet symbol will be displayed on the schematic sheet. If the value is False, the hidden text fields are not shown on the schematic.
Example
ShowHiddenFields := SSheet.GetState_ShowHiddenFields;
See also
ISch_SheetSymbol interface

GetState_SchSheetName method

(ISch_SheetSymbol interface)
Syntax
Function GetState_SchSheetName : ISch_SheetName;
Description
The GetState_SchSheetName function returns the ISch_SheetName interface object which represents the Designator object associated with the sheet symbol. The ISch_Sheetname interface is inherited from the ISch_ComplexText and ISch_Label interfaces.
Example

SheetName := SSheet.GetState_SchSheetName;
If SheetName <> Nil Then
    Showmessage(SheetName.Text);

See also
ISch_SheetName interface;
ISch_SheetSymbol interface

GetState_SchSheetFileName method

(ISch_SheetSymbol interface)
Syntax
Function GetState_SchSheetFileName : ISch_SheetFileName;
Description
The GetState_SchSheetFileName function returns the ISch_SheetFileName interface object which represents the FileName text object associated with the sheet symbol. The ISch_SheetFileName interface is inherited from the ISch_ComplexText and ISch_Label interfaces.
Example

SheetFileName := SSheet.GetState_SchSheetFileName;
If SheetFileName <> Nil Then
    Showmessage(SheetFileName.Text);

See also
ISch_SheetFileName interface;
ISch_SheetSymbol interface

GetState_LineWidth method

(ISch_SheetSymbol interface)
Syntax
Function GetState_LineWidth : TSize;
Description
The GetState_LineWidth function returns the size of the border of the sheet symbol. The Size value is of TSize type.
Example
LineWidth := SSheet.GetState_LineWidth;
See also
TSize type
ISch_SheetSymbol interface

GetState_IsSolid method

(ISch_SheetSymbol interface)
Syntax
Function GetState_IsSolid : Boolean;
Description
The GetState_IsSolid function returns a Boolean value whether the sheet symbol object has a solid internal fill or not.
Example

If Pie.GetState_IsSolid Then
    Pie. AreaColor := 0; // black fill

See also
ISch_SheetSymbol interface

Properties

ShowHiddenFields property

(ISch_SheetSymbol interface)
Syntax
Property ShowHiddenFields : Boolean Read GetState_ShowHiddenFields Write SetState_ShowHiddenFields;
Description
The ShowHiddenFields property determines the visibility of the text fields associated with the sheet symbol, such as its name and filename. If the Value is true, the hidden fields of the sheet symbol will be displayed on the schematic sheet. If the value is False, the hidden text fields are not shown on the schematic.
Example
SSheet.ShowHiddenFields := True;
See also
ISch_SheetSymbol interface

SheetName property

(ISch_SheetSymbol interface)
Syntax
Property SheetName : ISch_SheetName Read GetState_SchSheetName;
Description
The SchSheetName property denotes the Designator Name text object which is represented by the ISch_SheetName interface object associated with the sheet symbol. The ISch_SheetName interface is inherited from the ISch_ComplexText and ISch_Label interfaces. This property is supported by GetState_SchSheetname method.
Example

SheetName := SSheet.SchSheetName;
If SheetName <> Nil Then
    Showmessage(SheetName.Text);

See also
ISch_SheetSymbol interface

SheetFileName property

(ISch_SheetSymbol interface)
Syntax
Property SheetFileName : ISch_SheetFileName Read GetState_SchSheetFileName;
Description
The SchSheetFileName property denotes the FileName text object which is represented by the ISch_SheetFileName interface object associated with the sheet symbol. The ISch_SheetFileName interface is inherited from the ISch_ComplexText and ISch_Label interfaces. This property is supported by GetState_SchSheetFileName method.
Example

SheetFileName := SSheet.SchSheetFileName;
If SheetFileName <> Nil Then
    Showmessage(SheetFileName.Text);

See also
ISch_SheetSymbol interface

LineWidth property

(ISch_SheetSymbol interface)
Syntax
Property LineWidth : TSize Read GetState_LineWidth Write SetState_LineWidth;
Description
The LineWidth property defines the border width of the sheet symbol with one of the following values from the TSize enumerated type. This property is supported by the GetState_LineWidth and SetState_LineWidth methods.
Example
See also
ISch_SheetSymbol interface
TSize type

IsSolid property

(ISch_SheetSymbol interface)
Syntax
Property IsSolid : Boolean Read GetState_IsSolid Write SetState_IsSolid;
Description
Description
The IsSolid property denotes whether the sheet symbol object has a solid fill or not. This property is supported by the GetState_IsSolid and SetState_IsSolid methods.
Example
SScheet.IsSolid := True;
See also
ISch_SheetSymbol interface

UniqueId property

(ISch_SheetSymbol interface)
Syntax
Property UniqueId : WideString Read GetState_UniqueId Write SetState_UniqueId;
Description
The SetState_UniqueID property sets the new ID for the sheet symbol. All parameters, sheet symbols, ports, pins, components, openbus links, openbus ports and openbus components have Unique IDs. Unique IDs are used to maintain design synchronization in design projects.

The Unique ID (UID) is an system generated value that uniquely identifies this current sheet symbol. It is used for linking to a PCB document and for project management. Enter a new UID value or click the Reset button to generate a new UID for this design object from the Change Properties dialog. You can also globally reset UIDs of components and sheet symbols from the Schematic Editor’s Tools » Convert » Reset Component Unique IDs menu.
Example
UID := WSM.DM_GenerateUniqueID; // interface and method from Workspace Manager API.
SheetSymbol.UniqueID(UID);

See also
ISch_SheetSymbol interface

ISch_Symbol Interface

Overview
The symbol objects are special markers used for components in the Schematic Library.
Notes
Descended from ISch_GraphicalObject

ISch_Symbol methods
SetState_Orientation
SetState_Symbol
SetState_IsMirrored
SetState_LineWidth
SetState_ScaleFactor
GetState_Orientation
GetState_Symbol
GetState_IsMirrored
GetState_LineWidth
GetState_ScaleFactor
ISch_Symbol properties
Orientation
Symbol
IsMirrored
LineWidth
ScaleFactor

See also
ISch_GraphicalObject interface

Methods

SetState_Symbol method

(ISch_Symbol interface)
Syntax
Procedure SetState_Symbol (AValue : TIeeeSymbol);
Description
Example
See also
ISch_Symbol interface

SetState_ScaleFactor method

(ISch_Symbol interface)
Syntax
Procedure SetState_ScaleFactor(AValue : TCoord);
Description
Example
See also
ISch_Symbol interface

SetState_Orientation method

(ISch_Symbol interface)
Syntax
Procedure SetState_Orientation(AValue : TRotationBy90);
Description
Example
See also
ISch_Symbol interface

SetState_LineWidth method

(ISch_Symbol interface)
Syntax
Procedure SetState_LineWidth (AValue : TSize);
Description
Example
See also
ISch_Symbol interface

SetState_IsMirrored method

(ISch_Symbol interface)
Syntax
Procedure SetState_IsMirrored (AValue : Boolean);
Description
Example
See also
ISch_Symbol interface

GetState_Symbol method

(ISch_Symbol interface)
Syntax
Function GetState_Symbol : TIeeeSymbol;
Description
Example
See also
ISch_Symbol interface

GetState_ScaleFactor method

(ISch_Symbol interface)
Syntax
Function GetState_ScaleFactor : TCoord;
Description
Example
See also
ISch_Symbol interface

GetState_Orientation method

(ISch_Symbol interface)
Syntax
Function GetState_Orientation : TRotationBy90;
Description
Example
See also
ISch_Symbol interface

GetState_LineWidth method

(ISch_Symbol interface)
Syntax
Function GetState_LineWidth : TSize;
Description
Example
See also
ISch_Symbol interface

GetState_IsMirrored method

(ISch_Symbol interface)
Syntax
Function GetState_IsMirrored : Boolean;
Description
Example
See also
ISch_Symbol interface

Properties

Symbol property

(ISch_Symbol interface)
Syntax
Property Symbol : TIeeeSymbol Read GetState_Symbol Write SetState_Symbol ;
Description
Example
See also
ISch_Symbol interface

ScaleFactor property

(ISch_Symbol interface)
Syntax
Property ScaleFactor : TCoord Read GetState_ScaleFactor Write SetState_ScaleFactor;
Description
Example
See also
ISch_Symbol interface

Orientation property

(ISch_Symbol interface)
Syntax
Property Orientation : TRotationBy90 Read GetState_Orientation Write SetState_Orientation;
Description
Example
See also
ISch_Symbol interface

LineWidth property

(ISch_Symbol interface)
Syntax
Property LineWidth : TSize Read GetState_LineWidth Write SetState_LineWidth ;
Description
The LineWidth property defines the border width of the circle with one of the following values from the TSize enumerated type. This property is supported by the GetState_LineWidth and SetState_LineWidth methods.
Example
See also
ISch_Symbol interface
TSize type

IsMirrored property

(ISch_Symbol interface)
Syntax
Property IsMirrored : Boolean Read GetState_IsMirrored Write SetState_IsMirrored ;
Description
Example
See also
ISch_Symbol interface

ISch_Template Interface

Overview
The schematic templates represent the sheet border, title block and graphics for a schematic document.
Notes
The ISch_Template interface hierarchy is as follows:
ISch_GraphicalObject
ISch_Template

ISch_Template methods
SetState_FileName
GetState_FileName
ISch_Template properties
FileName

See also
ISch_GraphicalObject interface

Methods

SetState_FileName method

(ISch_Template interface)
Syntax
Procedure SetState_FileName(AValue : WideString);
Description
Example
See also
ISch_Template interface

GetState_FileName method

(ISch_Template interface)
Syntax
Function GetState_FileName : WideString;
Description
Example
See also
ISch_Template interface

Properties

FileName property

(ISch_Template interface)
Syntax
Property FileName : WideString Read GetState_FileName Write SetState_FileName;
Description
Example
See also
ISch_Template interface

ISch_TextFrame Interface

Overview
Text frames hold multiple lines of free text.
Notes
ISch_TextFrame interface hierarchy is as follows:
ISch_GraphicalObject
ISch_Rectangle
ISch_TextFrame

  • The FontID property denotes the font type of the TextFrame object.  Windows True Type fonts are fully supported. The FontID value denotes which font has been used.  The FontID is the index to an entry in the font table in the Schematic editor.  Each font used in the Schematic editor has its own FontID. 
  • When a new font is used (through a Change Font dialog), a new FontID is added to the internal table in the Schematic editor. The FontID value can be extracted from the following Schematic objects (TextField, Sheet, Annotation, TextFrame and NetLabel objects).
ISch_TextFrame methods
SetState_FontId
SetState_TextColor
SetState_Alignment
SetState_WordWrap
SetState_ShowBorder
SetState_ClipToRect
GetState_FontId
GetState_TextColor
GetState_Alignment
GetState_WordWrap
GetState_ShowBorder
GetState_ClipToRect
ISch_TextFrame properties
FontId
TextColor
Alignment
WordWrap
ShowBorder
ClipToRect
Text

See also

Methods

SetState_WordWrap method

(ISch_TextFrame interface)
Syntax
Procedure SetState_WordWrap (AValue : Boolean);
Description
Example
See also
ISch_TextFrame interface

SetState_TextColor method

(ISch_TextFrame interface)
Syntax
Procedure SetState_TextColor (AValue : TColor);
Description
Example
See also
ISch_TextFrame interface

SetState_ShowBorder method

(ISch_TextFrame interface)
Syntax
Procedure SetState_ShowBorder (AValue : Boolean);
Description
Example
See also
ISch_TextFrame interface

SetState_FontId method

(ISch_TextFrame interface)
Syntax
Procedure SetState_FontId (AValue : Integer);
Description
Example
See also
ISch_TextFrame interface

SetState_ClipToRect method

(ISch_TextFrame interface)
Syntax
Procedure SetState_ClipToRect (AValue : Boolean);
Description
Example
See also
ISch_TextFrame interface

SetState_Alignment method

(ISch_TextFrame interface)
Syntax
Procedure SetState_Alignment (AValue : THorizontalAlign);
Description
Example
See also
ISch_TextFrame interface

GetState_WordWrap method

(ISch_TextFrame interface)
Syntax
Function GetState_WordWrap : Boolean;
Description
Example
See also
ISch_TextFrame interface

GetState_TextColor method

(ISch_TextFrame interface)
Syntax
Function GetState_TextColor : TColor;
Description
Example
See also
ISch_TextFrame interface

GetState_ShowBorder method

(ISch_TextFrame interface)
Syntax
Function GetState_ShowBorder : Boolean;
Description
Example
See also
ISch_TextFrame interface

GetState_FontId method

(ISch_TextFrame interface)
Syntax
Function GetState_FontId : Integer;
Description
Example
See also
ISch_TextFrame interface

GetState_ClipToRect method

(ISch_TextFrame interface)
Syntax
Function GetState_ClipToRect : Boolean;
Description
Example
See also
ISch_TextFrame interface

GetState_Alignment method

(ISch_TextFrame interface)
Syntax
Function GetState_Alignment : THorizontalAlign;
Description
Example
See also
ISch_TextFrame interface

Properties

FontId property

(ISch_TextFrame interface)
Syntax
Property FontId : Integer Read GetState_FontId Write SetState_FontId;
Description
Example
See also
ISch_TextFrame interface

WordWrap property

(ISch_TextFrame interface)
Syntax
Property WordWrap : Boolean Read GetState_WordWrap Write SetState_WordWrap;
Description
Example
See also
ISch_TextFrame interface

TextColor property

(ISch_TextFrame interface)
Syntax
Property TextColor : TColor Read GetState_TextColor Write SetState_TextColor;
Description
Example
See also
ISch_TextFrame interface

Text property

(ISch_TextFrame interface)
Syntax
Property Text : WideString Read GetState_Text Write SetState_Text;
Description
Example
See also
ISch_TextFrame interface

ShowBorder property

(ISch_TextFrame interface)
Syntax
Property ShowBorder : Boolean Read GetState_ShowBorder Write SetState_ShowBorder;
Description
Example
See also
ISch_TextFrame interface

ClipToRect property

(ISch_TextFrame interface)
Syntax
Property ClipToRect : Boolean Read GetState_ClipToRect Write SetState_ClipToRect;
Description
Example
See also
ISch_TextFrame interface

Alignment property

(ISch_TextFrame interface)
Syntax
Property Alignment : THorizontalAlign Read GetState_Alignment Write SetState_Alignment;
Description
Example
See also
ISch_TextFrame interface

ISch_Wire Interface

Overview
Wires are straight line segments which are placed on a schematic document to create the electrical connections.
Notes
The ISch_Wire interface is descended from the immediate ancestor ISch_BasicPolyline interface and the interface hierarchy is as follows:
ISch_GraphicalObject
    ISch_Polygon
        ISch_BasicPolyline
            ISch_Wire

ISch_Wire methods
GetState_CompilationMaskedSegment
SetState_CompilationMaskedSegment
ISch_Wire properties
CompilationMaskedSegment

Fetch the vertices of existing wires example

Procedure FetchVertices();
Var
    Index      : Integer;
    Wire       : ISch_Wire;
    Iterator   : ISch_Iterator;
    WireCount  : Integer;
    ALocation  : TLocation;
    SchDoc     : ISch_Document;
    Document   : IServerDocument;
    ReportList : TStringList;
Begin
    If SchServer = Nil Then Exit;
    SchDoc := SchServer.GetCurrentSchDocument;
    If SchDoc = Nil Then Exit;
 
    // Set up an iterator to look for port objects only.
    Iterator := SchDoc.SchIterator_Create;
    Iterator.AddFilter_ObjectSet(MkSet(eWire));
 
    WireCount := 0;
    ReportList := TStringList.Create;
    ReportList.Add('Wires'' Vertex report:');
    ReportList.Add('______________________');
    ReportList.Add('');
 
    // Using a Try Finally block to avoid exception errors.
    Try
        Wire := Iterator.FirstSchObject;
        While Wire <> Nil Do
        Begin
            Inc(WireCount);
            ReportList.Add('Wire #' + IntToStr(WireCount));
            For Index := 1 To Wire.VerticesCount Do
            Begin
                ALocation := Wire.Vertex[Index];
                ReportList.Add('X: ' + IntToStr(ALocation.X) + ', Y: ' + IntToStr(ALocation.Y));
            End;
 
            ReportList.Add('');
            Wire := Iterator.NextSchObject;
        End;
 
    Finally
        SchDoc.SchIterator_Destroy(Iterator);
    End;
 
    ReportList.SaveToFile('C:\WireVertexReport.Txt');
    ReportList.Free;
 
    // Display the report containing parameters for each component found.
    Document := Client.OpenDocument('Text','C:\WireVertexReport.txt');
    If Document <> Nil Then
        Client.ShowDocument(Document);
End;

See also
ISch_GraphicalObject interface
ISch_Polygon interface
ISch_BasicPolyline interface

Methods

GetState_CompilationMaskedSegment method

(ISch_Wire interface)
Syntax
Function GetState_CompilationMaskedSegment(AIndex : Integer) : Boolean;
Description
Example
See also
ISch_Wire interface

SetState_CompilationMaskedSegment method

(ISch_Wire interface)
Syntax
Procedure SetState_CompilationMaskedSegment(AIndex : Integer; AValue : Boolean);
Description
Example
See also
ISch_Wire interface

Properties

CompilationMaskedSegment property

(ISch_Wire interface)
Syntax
Property CompilationMaskedSegment[AIndex : Integer] : Boolean Read GetState_CompilationMaskedSegment Write SetState_CompilationMaskedSegment;
Description
Example
See also
ISch_Wire interface

You are reporting an issue with the following selected text and/or image within the active document:
ALTIUM DESIGNER FREE TRIAL
Altium Designer Free Trial
Let’s get started. First off, are you or your organization already using Altium Designer?

If would like to speak with a representative, please contact your local Altium office.
Copyright © 2019 Altium Limited

In that case, why do you need an evaluation license?

If would like to speak with a representative, please contact your local Altium office.
Copyright © 2019 Altium Limited

Got it. You actually don’t need an evaluation license for that.

Click the button below to download the latest Altium Designer installer.

Download Altium Designer Installer

If would like to speak with a representative, please contact your local Altium office.
Copyright © 2019 Altium Limited

Please fill out the form below to get a quote for a new seat of Altium Designer.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

If you are on Altium Subscription, you don’t need an evaluation license.

If you are not an active Altium Subscription member, please fill out the form below to get your free trial.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

Why are you looking to evaluate Altium Designer?

If would like to speak with a representative, please contact your local Altium office.
Copyright © 2019 Altium Limited

You came to the right place! Please fill out the form below to get your free trial started.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

Sounds exciting! Did you know we offer special discounted student licenses? For more information, click here.

In the meantime, feel free to request a free trial by filling out the form below.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

Got it. You can download a free Altium Designer Viewer license which is valid for a 6 months.

Please fill out the form below to request one.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

That’s great! Making things is awesome. We have the perfect program for you.

Upverter is a free community-driven platform designed specifically to meet the needs of makers like you.

Click here to give it a try!

If would like to speak with a representative, please contact your local Altium office.
Copyright © 2019 Altium Limited

Got it. You can download a free Altium Designer Viewer license which is valid for a 6 months.

Please fill out the form below to request one.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.