ISch_Polygon interface
Polygons are multi-sided graphical elements. The vertices of a polygon object denote the link of lines to describe its outline.
public interface ISch_Polygon : ISch_GraphicalObject
Namespace: SCH · Assembly: Altium.SDK.Interfaces
Inherits: ISch_BasicContainer → ISch_GraphicalObject
Derived: ISch_BasicPolyline, ISch_CollapsiblePolygon
Remarks
ISch_Polygon interface
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| IsSolid | bool | get; set | |
| LineWidth | TSize | get; set | The LineWidth property defines the border width of the polygon with one of the following values from the TSize enumerated type. |
| Transparent | bool | get; set | |
| Vertex | Point | get; set | |
| VerticesCount | int | get; set |
IsSolid
No description yet.
bool GetState_IsSolid();
void SetState_IsSolid(bool argValue);
Type: bool · Access: read/write
LineWidth
The LineWidth property defines the border width of the polygon with one of the following values from the TSize enumerated type.
TSize GetState_LineWidth();
void SetState_LineWidth(TSize argValue);
Type: TSize · Access: read/write
The accessors are extension methods of ISch_PolygonHelper (using SCH;).
See also: TSize
Transparent
No description yet.
bool GetState_Transparent();
void SetState_Transparent(bool argB);
Type: bool · Access: read/write
Vertex
No description yet.
Point GetState_Vertex(int argI);
void SetState_Vertex(int argI, Point argLocation);
Type: Point · Access: read/write · Index: argI (int)
The accessors are extension methods of ISch_PolygonHelper (using SCH;).
VerticesCount
No description yet.
int GetState_VerticesCount();
void SetState_VerticesCount(int argValue);
Type: int · Access: read/write
Methods
| Method | Returns | Description |
|---|---|---|
| ClearAllVertices | void | |
| InsertVertex | bool | |
| RemoveVertex | bool |
ClearAllVertices
No description yet.
void ClearAllVertices();
Returns: nothing (void)
InsertVertex
No description yet.
bool InsertVertex(int argIndex);
| Parameter | Type | Passing |
|---|---|---|
argIndex | int | value |
Returns: bool
RemoveVertex
No description yet.
bool RemoveVertex(ref int argIndex);
| Parameter | Type | Passing |
|---|---|---|
argIndex | int | ref |
Returns: bool
Inherited members
- From ISch_GraphicalObject: AddErrorString, AreaColor, BoundingRectangle, BoundingRectangle_Full, Color, CompilationMasked, Dimmed, Disabled, DisplayError, EnableDraw, ErrorColor, ErrorKind, ErrorString, GetHash, GraphicallyInvalidate, LiveHighlightValue, Location, Mirror, MoveByXY, MoveToXY, OwnerPartDisplayMode, OwnerPartId, ResetErrorFields, RotateBy90, Selection, SetState_xSizeySize
- From ISch_BasicContainer: AddAndPositionSchObject, AddSchObject, CopyTo, DeleteAll, DescriptionString, ExportToParameters, FreeAllContainedObjects, Handle, IdentifierString, Import_FromUser, ObjectId, OwnerSchDocument, RemoveSchObject, Replicate, SchBasicContainer, SchIterator_Create, SchIterator_Destroy, SchParameterByName, Setstate_Default, Text, UniqueId, WiringDiagramOriginUniqueId