Interface IAnnotations

Gives access to annotations in drafting documents.

Namespace: TopSolid.Cad.Drafting.Automating

Assembly: TopSolid.Cad.Drafting.Automating.dll

Syntax

[ServiceContract]
[AvailableSinceVersion(7, 17, 0, 0)]
public interface IAnnotations

Remarks

This interface is available since v7.17.

Methods

GetAnnotationType(ElementId)

Gets the annotation type of an annotation entity.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 17, 0, 0)]
AnnotationType GetAnnotationType(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the element to analyze.

Returns

Type	Description
AnnotationType	The annotation type.

Remarks

This method is available since v7.17.

GetGeometricToleranceDatumSystemGroupValues(ElementId, Int32, Int32, Int32, out List<String>, out List<ModifierType>)

Gets the geometric tolerance datum system group values.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 17, 0, 0)]
void GetGeometricToleranceDatumSystemGroupValues(ElementId inGeometricTolerance, int inToleranceFrameIndex, int inDatumSystemGroupIndex, int inGroupOfDatumIndex, out List<string> outText, out List<ModifierType> outModifiers)

Parameters

Type	Name	Description
ElementId	inGeometricTolerance	Identifier of the element to analyze.
Int32	inToleranceFrameIndex	Index of the tolerance frame.
Int32	inDatumSystemGroupIndex	Index of the datum feature system.
Int32	inGroupOfDatumIndex	Index of the group of datum.
List<String>	outText	The texts.
List<ModifierType>	outModifiers	The modifiers.

Remarks

This method is available since v7.17.

GetGeometricToleranceFrameDatumFeatureSystemCount(ElementId, Int32)

Gets the datum features system count of a geometric tolerance frame.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 17, 0, 0)]
int GetGeometricToleranceFrameDatumFeatureSystemCount(ElementId inGeometricTolerance, int inToleranceFrameIndex)

Parameters

Type	Name	Description
ElementId	inGeometricTolerance	Identifier of the element to analyze.
Int32	inToleranceFrameIndex	Index of the tolerance frame.

Returns

Type	Description
Int32	The count of datum features system.

Remarks

This method is available since v7.17.

GetGeometricToleranceFrameGroupDatumFeatureCount(ElementId, Int32, Int32)

Gets the datum feature count of a datum feature system.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 17, 0, 0)]
int GetGeometricToleranceFrameGroupDatumFeatureCount(ElementId inGeometricTolerance, int inToleranceFrameIndex, int inDatumSystemGroupIndex)

Parameters

Type	Name	Description
ElementId	inGeometricTolerance	Identifier of the element to analyze.
Int32	inToleranceFrameIndex	Index of the tolerance frame.
Int32	inDatumSystemGroupIndex	Index of the datum feature system.

Returns

Type	Description
Int32	The count of datum feature.

Remarks

This method is available since v7.17.

GetGeometricToleranceFrameModifierType(ElementId, Int32)

Gets the modifier type of a geometric tolerance frame.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 17, 0, 0)]
ModifierType GetGeometricToleranceFrameModifierType(ElementId inGeometricTolerance, int inToleranceFrameIndex)

Parameters

Type	Name	Description
ElementId	inGeometricTolerance	Identifier of the element to analyze.
Int32	inToleranceFrameIndex	Index of the tolerance frame.

Returns

Type	Description
ModifierType	The modifier type.

Remarks

This method is available since v7.17.

GetGeometricToleranceFrameOtherModifierType(ElementId, Int32)

Gets the other modifier type of a geometric tolerance frame.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 17, 0, 0)]
ModifierType GetGeometricToleranceFrameOtherModifierType(ElementId inGeometricTolerance, int inToleranceFrameIndex)

Parameters

Type	Name	Description
ElementId	inGeometricTolerance	Identifier of the element to analyze.
Int32	inToleranceFrameIndex	Index of the tolerance frame.

Returns

Type	Description
ModifierType	The modifier type.

Remarks

This method is available since v7.17.

GetGeometricToleranceFrameToleranceSymbolType(ElementId, Int32)

Gets the tolerance symbol type of a geometric tolerance frame.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 17, 0, 0)]
ToleranceSymbolType? GetGeometricToleranceFrameToleranceSymbolType(ElementId inGeometricTolerance, int inToleranceFrameIndex)

Parameters

Type	Name	Description
ElementId	inGeometricTolerance	Identifier of the element to analyze.
Int32	inToleranceFrameIndex	Index of the tolerance frame.

Returns

Type	Description
Nullable<ToleranceSymbolType>	The tolerance symbol type.

Remarks

This method is available since v7.17.

GetGeometricToleranceFrameToleranceValue(ElementId, Int32)

Gets the tolerance value of a geometric tolerance frame.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 17, 0, 0)]
Real GetGeometricToleranceFrameToleranceValue(ElementId inGeometricTolerance, int inToleranceFrameIndex)

Parameters

Type	Name	Description
ElementId	inGeometricTolerance	Identifier of the element to analyze.
Int32	inToleranceFrameIndex	Index of the tolerance frame.

Returns

Type	Description
Real	The value of the tolerance frame.

Remarks

This method is available since v7.17.

GetGeometricToleranceFrameToleranceZoneType(ElementId, Int32)

Gets the tolerance zone type of a geometric tolerance frame.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 17, 0, 0)]
ToleranceZoneType GetGeometricToleranceFrameToleranceZoneType(ElementId inGeometricTolerance, int inToleranceFrameIndex)

Parameters

Type	Name	Description
ElementId	inGeometricTolerance	Identifier of the element to analyze.
Int32	inToleranceFrameIndex	Index of the tolerance frame.

Returns

Type	Description
ToleranceZoneType	The tolerance zone type.

Remarks

This method is available since v7.17.

GetGeometricToleranceTolerancesFrameCount(ElementId)

Gets the tolerance frame count of a geometric tolerance entity.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 17, 0, 0)]
int GetGeometricToleranceTolerancesFrameCount(ElementId inGeometricTolerance)

Parameters

Type	Name	Description
ElementId	inGeometricTolerance	Identifier of the element to analyze.

Returns

Type	Description
Int32	Count of tolerance frames.

Remarks

This method is available since v7.17.

GetSurfaceFinishItemStriaOrientationValue(ElementItemId)

Gets the surface finish item stria orientation value of an item of a surface finish annotation entity.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 17, 0, 0)]
SurfaceFinishStriaOrientation GetSurfaceFinishItemStriaOrientationValue(ElementItemId inElementItemId)

Parameters

Type	Name	Description
ElementItemId	inElementItemId	Identifier of the element item to analyze.

Returns

Type	Description
SurfaceFinishStriaOrientation	The stria orientation value.

Remarks

This method is available since v7.17.

GetSurfaceFinishItemSymbolValue(ElementItemId)

Gets the surface finish item symbol value type of an item of a surface finish annotation entity.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 17, 0, 0)]
SurfaceFinishSymbolType GetSurfaceFinishItemSymbolValue(ElementItemId inElementItemId)

Parameters

Type	Name	Description
ElementItemId	inElementItemId	Identifier of the element item to analyze.

Returns

Type	Description
SurfaceFinishSymbolType	The symbol value type.

Remarks

This method is available since v7.17.

GetSurfaceFinishItemTextValue(ElementItemId)

Gets the surface finish item text value of an item of a surface finish annotation entity.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 17, 0, 0)]
string GetSurfaceFinishItemTextValue(ElementItemId inElementItemId)

Parameters

Type	Name	Description
ElementItemId	inElementItemId	Identifier of the element item to analyze.

Returns

Type	Description
String	The text value.

Remarks

This method is available since v7.17.

GetSurfaceFinishItemType(ElementItemId)

Gets the surface finish item type of an item of a surface finish annotation entity.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 17, 0, 0)]
SurfaceFinishItemType GetSurfaceFinishItemType(ElementItemId inElementItemId)

Parameters

Type	Name	Description
ElementItemId	inElementItemId	Identifier of the element item to analyze.

Returns

Type	Description
SurfaceFinishItemType	The surface finish item type.

Remarks

This method is available since v7.17.

GetSurfaceFinishItemValueType(ElementItemId)

Gets the surface finish item value type of an item of a surface finish annotation entity.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 17, 0, 0)]
SurfaceFinishItemValueType GetSurfaceFinishItemValueType(ElementItemId inElementItemId)

Parameters

Type	Name	Description
ElementItemId	inElementItemId	Identifier of the element item to analyze.

Returns

Type	Description
SurfaceFinishItemValueType	The surface finish item value type.

Remarks

This method is available since v7.17.