 | IPortal |
Represents a portal frame
Namespace: TSD.API.Remoting.PortalFrames
Assembly: TSD.API.Remoting (in TSD.API.Remoting.dll) Version: 24.0.1.45+53a79b69d75fb81c51fcd389e0bdcf241e5b9f7c
SyntaxThe IPortalFrame type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AutoDesign | Gets a value indicating whether this portal frame is auto-designed |
| ConstructionPlaneInfo | Gets the EntityInfo of the IConstructionPlane the portal frame is constructed in |
| ElementGroupName |
Gets the name of the element group
(Inherited from IEntity) |
| EntityType |
Gets the type of the entity
(Inherited from IEntity) |
| Id |
Gets the ID
(Inherited from IHaveId) |
| Index |
Gets the index
(Inherited from IHaveIndex) |
| Name |
Gets the name
(Inherited from IHaveName) |
| Offset | Gets the offset of the portal frame from the plane origin |
| OrientationFactor | Gets the orientation factor for the x-axis of the portal frame relative to the plane (either +1 or -1) |
| Plane | Gets the IPlane the portal frame is constructed in |
| ReferenceConstructionPointIndices | Gets the indices of reference IConstructionPoints of the portal frame |
| SpanCount | Gets the number of spans |
| ValleyCount | Gets the number of valleys |
Methods| Name | Description | |
|---|---|---|
 | GetSpanAsync | Returns the spans from the given indices |
| GetUserDefinedAttributesAsync |
Returns a collection of IUserDefinedAttribute instances
(Inherited from IHaveUserDefinedAttributes) |
| GetValleyAsync | Returns the valleys from the given indices |
| SetUserDefinedAttributeAsync |
Sets an user defined text attribute
(Inherited from IHaveUserDefinedAttributes) |
| SetUserDefinedAttributesAsync |
Sets user defined attributes
(Inherited from IHaveUserDefinedAttributes) |
| SetUserDefinedEmbeddedFileAttributeAsync |
Sets an user defined embedded file attribute
(Inherited from IHaveUserDefinedAttributes) |
See Also