Interface IOptions
Gives access to the options of a document.
Namespace: TopSolid.Kernel.Automating
Assembly: cs.temp.dll.dll
Syntax
[AvailableSinceVersion(7, 8, 0, 0)]
public interface IOptionsRemarks
This interface is available since v7.8.
Methods
GetFileCompressionType(DocumentId)
Gets the compression type of a document file.
Declaration
[AvailableSinceVersion(7, 12, 300, 160)]
CompressionType GetFileCompressionType(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| CompressionType | Compression type of the document file. |
Remarks
This method is available since v7.12.300.160.
GetModelingTolerances(DocumentId, out Double, out Double)
Gets the modeling tolerances of a document.
Declaration
[AvailableSinceVersion(7, 8, 0, 0)]
void GetModelingTolerances(DocumentId inDocumentId, out double outLinearTolerance, out double outAngularTolerance)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
| System.Double | outLinearTolerance | Linear tolerance (in meters). |
| System.Double | outAngularTolerance | Angular tolerance (in radians). |
Remarks
This method is available since v7.8.
GetUpdateModes(DocumentId, out Boolean, out Boolean)
Gets the update modes of a document.
Declaration
[AvailableSinceVersion(7, 12, 300, 160)]
void GetUpdateModes(DocumentId inDocumentId, out bool outIsHealing, out bool outIsTolerant)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
| System.Boolean | outIsHealing | Whether update automatically heals damaged operations. |
| System.Boolean | outIsTolerant | Whether update ignores modifications that are less than standard precision. |
Remarks
This method is available since v7.12.300.160.
GetVisualizationTolerances(DocumentId, out Double, out Double)
Gets the visualization tolerances of a document.
Declaration
[AvailableSinceVersion(7, 8, 0, 0)]
void GetVisualizationTolerances(DocumentId inDocumentId, out double outLinearTolerance, out double outAngularTolerance)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
| System.Double | outLinearTolerance | Linear tolerance (in meters). |
| System.Double | outAngularTolerance | Angular tolerance (in radians). |
Remarks
This method is available since v7.8.
SetFileCompressionType(DocumentId, CompressionType)
Sets the compression type of a document file.
Declaration
[AvailableSinceVersion(7, 12, 300, 160)]
void SetFileCompressionType(DocumentId inDocumentId, CompressionType inCompressionType)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| CompressionType | inCompressionType | Compression type of the document file. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.12.300.160.
SetModelingTolerances(DocumentId, Double, Double)
Sets the modeling tolerances of a document.
Declaration
[AvailableSinceVersion(7, 8, 0, 0)]
void SetModelingTolerances(DocumentId inDocumentId, double inLinearTolerance, double inAngularTolerance)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| System.Double | inLinearTolerance | Linear tolerance (in meters, within [0.0001mm,0.1mm]). |
| System.Double | inAngularTolerance | Angular tolerance (in radians, within [0.01°,10°]). |
Remarks
The document modeling tolerances are used as default modeling tolerances for new operations, changing them has no impact on existing operations.
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.8.
SetUpdateModes(DocumentId, Boolean, Boolean)
Sets the update modes of a document.
Declaration
[AvailableSinceVersion(7, 12, 300, 160)]
void SetUpdateModes(DocumentId inDocumentId, bool inIsHealing, bool inIsTolerant)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| System.Boolean | inIsHealing | Whether update automatically heals damaged operations. |
| System.Boolean | inIsTolerant | Whether update ignores modifications that are less than standard precision. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.12.300.160.
SetVisualizationTolerances(DocumentId, Double, Double)
Sets the visualization tolerances of a document.
Declaration
[AvailableSinceVersion(7, 8, 0, 0)]
void SetVisualizationTolerances(DocumentId inDocumentId, double inLinearTolerance, double inAngularTolerance)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| System.Double | inLinearTolerance | Linear tolerance (in meters, within [0.001mm,10mm]). |
| System.Double | inAngularTolerance | Angular tolerance (in radians, within [1°,90°]). |
Remarks
The document is automatically updated to take into account the new tolerances.
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.8.