Interface IEntities
Gives access to entities.
Namespace: TopSolid.Kernel.Automating
Assembly: cs.temp.dll.dll
Syntax
[AvailableSinceVersion(7, 6, 0, 0)]
public interface IEntitiesRemarks
This interface is available since v7.6.
Methods
AddSetTargets(ElementId, List<ElementId>)
Add targets to the set definition entity.
Declaration
[AvailableSinceVersion(7, 14, 300, 140)]
void AddSetTargets(ElementId inElementId, List<ElementId> inTargetIds)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifiers of the set definition entity. |
| List<ElementId> | inTargetIds | Identifiers of targets to add to the set definition entity. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.14.300.140.
Basify(ElementId)
Basifies an entity.
Declaration
[AvailableSinceVersion(7, 7, 201, 200)]
void Basify(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the entity to basify. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.7.201.200.
BasifySeveral(List<ElementId>)
Basifies several entities.
Declaration
[AvailableSinceVersion(7, 7, 201, 200)]
void BasifySeveral(List<ElementId> inElementIds)Parameters
| Type | Name | Description |
|---|---|---|
| List<ElementId> | inElementIds | Identifiers of the entities to basify. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.7.201.200.
CreateClassifying(DocumentId, ElementId)
Creates a classifying entity in a document.
Declaration
[AvailableSinceVersion(7, 10, 0, 0)]
ElementId CreateClassifying(DocumentId inDocumentId, ElementId inClassId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| ElementId | inClassId | Identifier of a class entity in a classification document. |
Returns
| Type | Description |
|---|---|
| ElementId | Classifying entity created identifier. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.10.
CreateFolder(ElementId)
Creates a folder entity inside a specified folder entity.
Declaration
[AvailableSinceVersion(7, 10, 0, 0)]
ElementId CreateFolder(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the folder entity to modify. |
Returns
| Type | Description |
|---|---|
| ElementId | Folder entity created identifier. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.10.
CreateSet(DocumentId, List<ElementId>)
Creates a set definition entity in a document.
Declaration
[AvailableSinceVersion(7, 14, 300, 120)]
ElementId CreateSet(DocumentId inDocumentId, List<ElementId> inTargetIds)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| List<ElementId> | inTargetIds | Identifiers of targets of the set definition entity. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the created set definition entity. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.14.300.120.
GetClassifyingClass(ElementId)
Gets the classification class entity of a specified classifying entity.
Declaration
[AvailableSinceVersion(7, 10, 0, 0)]
ElementId GetClassifyingClass(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the classifying entity to analyze. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the classifying class definition entity. |
Remarks
This method is available since v7.10.
GetClassifyings(DocumentId)
Gets the classifying entities that are in the classifyings folder of a document.
Declaration
[AvailableSinceVersion(7, 10, 0, 0)]
List<ElementId> GetClassifyings(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| List<ElementId> | Classifying entities found. |
Remarks
This method is available since v7.10.
GetCurrentSet(DocumentId)
Gets the current set definition entity in a document.
Declaration
[AvailableSinceVersion(7, 14, 300, 140)]
ElementId GetCurrentSet(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to get the current set. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the current set definition entity. |
Remarks
This method is available since v7.14.300.140.
GetFunctionDefinition(ElementId)
Gets the definition of a function entity.
Declaration
[AvailableSinceVersion(7, 8, 0, 0)]
DocumentId GetFunctionDefinition(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the function entity to analyze. |
Returns
| Type | Description |
|---|---|
| DocumentId | Identifier of the corresponding function definition document. |
Remarks
This method is available since v7.8.
GetFunctionOccurrenceName(ElementId)
Gets the occurrence name of a function entity.
Declaration
[AvailableSinceVersion(7, 8, 0, 0)]
string GetFunctionOccurrenceName(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the function entity to analyze. |
Returns
| Type | Description |
|---|---|
| System.String | Function occurrence name, or null if this type of function cannot be provided several times.. |
Remarks
This method is available since v7.8.
GetFunctionPublishings(ElementId)
Gets the publishing entities that are in a specified function of a document.
Declaration
[AvailableSinceVersion(7, 8, 0, 0)]
List<ElementId> GetFunctionPublishings(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the function entity to analyze. |
Returns
| Type | Description |
|---|---|
| List<ElementId> | Publishing entities found. |
Remarks
This method is available since v7.8.
GetFunctions(DocumentId)
Gets the function entities that are in the functions folder of a document.
Declaration
[AvailableSinceVersion(7, 8, 0, 0)]
List<ElementId> GetFunctions(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| List<ElementId> | Function entities found. |
Remarks
This method is available since v7.8.
GetOccurrenceDefinition(ElementId)
Gets the definition entity of an occurrence entity.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
ElementId GetOccurrenceDefinition(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the entity to analyze. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the definition entity of the occurrence. |
Remarks
This method is available since v7.6.
GetOccurrenceSource(ElementId)
Gets the source entity of an occurrence entity.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
ElementId GetOccurrenceSource(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the entity to analyze. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the source entity of the occurrence. |
Remarks
This method is available since v7.6.
GetPublishings(DocumentId)
Gets the publishing entities that are in the publishings folder of a document.
Declaration
[AvailableSinceVersion(7, 8, 0, 0)]
List<ElementId> GetPublishings(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| List<ElementId> | Publishing entities found. |
Remarks
This method is available since v7.8.
GetSets(DocumentId)
Gets the set definition entities that are in the sets folder of a document.
Declaration
[AvailableSinceVersion(7, 12, 0, 0)]
List<ElementId> GetSets(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| List<ElementId> | Set definition entities found. |
Remarks
The method GetConstituents(ElementId) may be used to explore the contents of a set definition.
Set definition constituents may be other set definition entities or shortcut entities which target entity may be obtained using the GetShortcutTarget(ElementId) method.
This method is available since v7.12.
GetShortcutTarget(ElementId)
Gets the target entity of a shortcut entity.
Declaration
[AvailableSinceVersion(7, 12, 0, 0)]
ElementId GetShortcutTarget(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the shortcut entity to analyze. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the target entity of the shortcut. |
Remarks
This method is available since v7.12.
IsBasifiable(ElementId)
Tells whether an entity may be basified.
Declaration
[AvailableSinceVersion(7, 7, 201, 200)]
bool IsBasifiable(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the entity to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | Whether the entity may be basified. |
Remarks
This method is available since v7.7.201.200.
IsEntity(ElementId)
Tells whether an element is an entity.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
bool IsEntity(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the element to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The element is an entity. |
Remarks
This method is available since v7.6.
IsFolder(ElementId)
Tells whether an element is a folder entity.
Declaration
[AvailableSinceVersion(7, 10, 0, 0)]
bool IsFolder(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the element to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The element is a folder entity. |
Remarks
This method is available since v7.10.
IsOccurrence(ElementId)
Tells whether an entity is an occurrence.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
bool IsOccurrence(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the entity to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The entity is an occurrence. |
Remarks
This method is available since v7.6.
IsSetDefinition(ElementId)
Tells whether an element is a set definition entity.
Declaration
[AvailableSinceVersion(7, 12, 0, 0)]
bool IsSetDefinition(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the element to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The element is a set definition entity. |
Remarks
This method is available since v7.12.
IsShortcut(ElementId)
Tells whether an entity is a shortcut.
Declaration
[AvailableSinceVersion(7, 12, 0, 0)]
bool IsShortcut(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the entity to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The entity is a shortcut. |
Remarks
This method is available since v7.12.
MoveEntity(ElementId, ElementId, Int32)
Moves an entity.
Declaration
[AvailableSinceVersion(7, 10, 0, 0)]
void MoveEntity(ElementId inElementId, ElementId inOwnerId, int inIndex)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the entity to move. |
| ElementId | inOwnerId | Identifier of the new owner folder entity. |
| System.Int32 | inIndex | Index of the entity in the new owner, or -1 for last. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.10.
ProvideFunction(DocumentId, DocumentId, String)
Provides a specified function in a document.
Declaration
[AvailableSinceVersion(7, 8, 0, 0)]
ElementId ProvideFunction(DocumentId inDocumentId, DocumentId inFunctionId, string inOccurrenceName)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| DocumentId | inFunctionId | Identifier of the function definition document. |
| System.String | inOccurrenceName | Provided function occurrence name, or null if this type of function cannot be provided several times. |
Returns
| Type | Description |
|---|---|
| ElementId | Function entity created identifier. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.8.
RemoveSetTargets(ElementId, List<ElementId>)
Remove targets to the set definition entity.
Declaration
[AvailableSinceVersion(7, 14, 300, 140)]
void RemoveSetTargets(ElementId inElementId, List<ElementId> inTargetIds)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifiers of the set definition entity. |
| List<ElementId> | inTargetIds | Identifiers of targets to add to the set definition entity. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.14.300.140.
SetClassifyingClass(ElementId, ElementId)
Sets the classification class entity of a specified classifying entity.
Declaration
[AvailableSinceVersion(7, 10, 0, 0)]
void SetClassifyingClass(ElementId inElementId, ElementId inClassId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the classifying entity to modify. |
| ElementId | inClassId | Identifier of the classifying class definition entity. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.10.
SetCurrentSet(DocumentId, ElementId)
Sets the current set definition entity in a document.
Declaration
[AvailableSinceVersion(7, 14, 300, 140)]
void SetCurrentSet(DocumentId inDocumentId, ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to set the current set. |
| ElementId | inElementId | Identifiers of the set definition entity. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.14.300.140.
SetFunctionOccurrenceName(ElementId, String)
Sets the occurrence name of a function entity.
Declaration
[AvailableSinceVersion(7, 8, 0, 0)]
void SetFunctionOccurrenceName(ElementId inElementId, string inOccurrenceName)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the function entity to modify. |
| System.String | inOccurrenceName | Occurrence name. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.8.
Transform(ElementId, Transform3D)
Creates a transform operation in a document.
Declaration
[AvailableSinceVersion(7, 13, 300, 0)]
ElementId Transform(ElementId inElementId, Transform3D inTransform)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the entity to modify. |
| Transform3D | inTransform | Transform to apply. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the transform operation. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.13.300.00.