Interface IRepresentations

Gives access to representations.

Namespace: TopSolid.Cad.Design.Automating

Assembly: TopSolid.Cad.Design.Automating.dll

Syntax

[ServiceContract]
[AvailableSinceVersion(7, 7, 201, 100)]
public interface IRepresentations

Remarks

This interface is available since v7.7.201.100.

Methods

AddRepresentationConstituent(ElementId, ElementId)

Adds a constituent to a representation entity.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 7, 201, 100)]
void AddRepresentationConstituent(ElementId inElementId, ElementId inConstituentId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the representation entity to modify.
ElementId	inConstituentId	Identifier of the entity to add to the representation.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.7.201.100.

CreateRepresentation(DocumentId)

Creates a representation entity in a specified document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 10, 300, 120)]
ElementId CreateRepresentation(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.

Returns

Type	Description
ElementId	Identifier of the created representation entity.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.10.300.120.

CreateSimplifiedRepresentation(DocumentId)

Creates the simplified representation entity in a specified document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 7, 201, 100)]
ElementId CreateSimplifiedRepresentation(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.

Returns

Type	Description
ElementId	Identifier of the created simplified representation entity.

Remarks

If the document already has a simplified representation, its identifier is returned and no new representation is created.

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.7.201.100.

GetCurrentRepresentation(DocumentId)

Gets the current representation entity of a document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 7, 201, 100)]
ElementId GetCurrentRepresentation(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
ElementId	Identifier of the current representation entity found.

Remarks

This method is available since v7.7.201.100.

GetDesignRepresentation(DocumentId)

Gets the design representation entity of a document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 7, 201, 100)]
ElementId GetDesignRepresentation(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
ElementId	Identifier of the design representation entity found.

Remarks

This method is available since v7.7.201.100.

GetDetailedRepresentation(DocumentId)

Gets the detailed representation entity of a document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 7, 201, 100)]
ElementId GetDetailedRepresentation(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
ElementId	Identifier of the detailed representation entity found.

Remarks

This method is available since v7.7.201.100.

GetRepresentationConstituents(ElementId)

Gets the constituents of a representation entity.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 7, 201, 100)]
List<ElementId> GetRepresentationConstituents(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the representation entity to analyze.

Returns

Type	Description
System.Collections.Generic.List<ElementId>	Constituent elements found.

Remarks

This method is available since v7.7.201.100.

GetRepresentations(DocumentId)

Gets the representations entities that are in the representations folder of a document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 7, 201, 100)]
List<ElementId> GetRepresentations(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
System.Collections.Generic.List<ElementId>	Representations entities found.

Remarks

This method is available since v7.7.201.100.

GetSimplifiedRepresentation(DocumentId)

Gets the simplified representation entity of a document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 7, 201, 100)]
ElementId GetSimplifiedRepresentation(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
ElementId	Identifier of the simplified representation entity found, or Empty if not found.

Remarks

This method is available since v7.7.201.100.

RemoveRepresentationConstituent(ElementId, ElementId)

Removes a constituent from a representation entity.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 7, 201, 100)]
void RemoveRepresentationConstituent(ElementId inElementId, ElementId inConstituentId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the representation entity to modify.
ElementId	inConstituentId	Identifier of the entity to remove from the representation.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.7.201.100.

SetCurrentRepresentation(ElementId)

Sets the current representation entity of a document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
void SetCurrentRepresentation(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the representation entity to become current.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.10.