Interface ITools
Gives access to various tools.
Namespace: TopSolid.Cad.Design.Automating
Assembly: TopSolid.Cad.Design.Automating.dll
Syntax
[ServiceContract]
[AvailableSinceVersion(7, 10, 0, 0)]
public interface IToolsRemarks
This interface is available since v7.10.
Methods
CreateAuxiliairyElement(DocumentId, List<ElementId>)
Creates an auxiliairy element in a document.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 13, 0, 0)]
ElementId CreateAuxiliairyElement(DocumentId inDocumentId, List<ElementId> inConstituents)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| System.Collections.Generic.List<ElementId> | inConstituents | Identifiers of constituents of the auxiliairy element. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the created auxiliairy entity. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.13.300.128.
CreateDerivedDocument(PdmObjectId, DocumentId, Boolean)
Creates a new derived part or assembly of a specified part or assembly.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
DocumentId CreateDerivedDocument(PdmObjectId inOwnerId, DocumentId inDocumentId, bool inUseDefaultTemplate)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inOwnerId | Identifier of owner. |
| DocumentId | inDocumentId | Identifier of the part or assembly document to derive. |
| System.Boolean | inUseDefaultTemplate | Tells whether to use the default template if present. |
Returns
| Type | Description |
|---|---|
| DocumentId | Derived part or assembly document identifier. |
Remarks
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.10.
CreateMirrorDocument(PdmObjectId, DocumentId, Boolean)
Creates the derived mirror part or assembly of a specified part or assembly.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
DocumentId CreateMirrorDocument(PdmObjectId inOwnerId, DocumentId inDocumentId, bool inUseDefaultTemplate)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inOwnerId | Identifier of owner. |
| DocumentId | inDocumentId | Identifier of the part or assembly document to derive. |
| System.Boolean | inUseDefaultTemplate | Tells whether to use the default template if present. |
Returns
| Type | Description |
|---|---|
| DocumentId | Derived mirror part or assembly document identifier. |
Remarks
If the specified part or assembly already has a symmetrical document (i.e. the method SearchSymmetricalDocument(DocumentId) does not return Empty), it is not allowed to create a derived mirror document, and this method throws an exception.
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.10.
CreatePlaneSymmetry(DocumentId, SmartPlane3D)
Creates a plane symmetry.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
ElementId CreatePlaneSymmetry(DocumentId inDocumentId, SmartPlane3D inPlane)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| SmartPlane3D | inPlane | Symmetry plane. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the created symmetry entity. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.10.
CreateRevolutionSymmetry(DocumentId, SmartAxis3D)
Creates a revolution symmetry.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
ElementId CreateRevolutionSymmetry(DocumentId inDocumentId, SmartAxis3D inAxis)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| SmartAxis3D | inAxis | Rotation and translation axis. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the created symmetry entity. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.10.
GetBaseDocument(DocumentId)
Gets the base part or assembly of a derived part or assembly.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
DocumentId GetBaseDocument(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the derived part or assembly document to analyze. |
Returns
| Type | Description |
|---|---|
| DocumentId | Base part or assembly document identifier, or empty if the part or assembly is not derived. |
Remarks
This method is available since v7.10.
GetCatalogCellCoatingValue(ElementId, ElementId)
Gets the coating value of the catalog cell.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 18, 400, 160)]
PdmObjectId GetCatalogCellCoatingValue(ElementId inRow, ElementId inParameterId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inRow | Identifier of the row. |
| ElementId | inParameterId | Identifier of the parameter of the column. |
Returns
| Type | Description |
|---|---|
| PdmObjectId | Value of the cell. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.18.
GetCatalogCellFinishingValue(ElementId, ElementId)
Gets the finishing value of the catalog cell.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 18, 400, 160)]
PdmObjectId GetCatalogCellFinishingValue(ElementId inRow, ElementId inParameterId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inRow | Identifier of the row. |
| ElementId | inParameterId | Identifier of the parameter of the column. |
Returns
| Type | Description |
|---|---|
| PdmObjectId | Value of the cell. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.18.
GetCatalogCellMaterialValue(ElementId, ElementId)
Gets the material value of the catalog cell.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 18, 400, 160)]
PdmObjectId GetCatalogCellMaterialValue(ElementId inRow, ElementId inParameterId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inRow | Identifier of the row. |
| ElementId | inParameterId | Identifier of the parameter of the column. |
Returns
| Type | Description |
|---|---|
| PdmObjectId | Value of the cell. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.18.
GetDerivationInheritances(DocumentId, out Boolean, out Boolean, out Boolean, out Boolean, out Boolean, out Boolean, out Boolean, out Boolean, out List<ElementId>, out Boolean, out Boolean, out Boolean, out Boolean, out Boolean, out Boolean, out Boolean, out Boolean, out Boolean, out Boolean, out Boolean, out Boolean, out Boolean, out Boolean)
Gets the derivation inheritances of a derived part or assembly.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
void GetDerivationInheritances(DocumentId inDocumentId, out bool outName, out bool outDescription, out bool outCode, out bool outPartNumber, out bool outComplementaryPartNumber, out bool outManufacturer, out bool outManufacturerPartNumber, out bool outComment, out List<ElementId> outOtherSystemParameters, out bool outNonSystemParameters, out bool outPoints, out bool outAxes, out bool outPlanes, out bool outFrames, out bool outSketches, out bool outShapes, out bool outPublishings, out bool outFunctions, out bool outSymmetries, out bool outUnsectionabilities, out bool outRepresentations, out bool outSets, out bool outCameras)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of derived part or assembly document to analyze. |
| System.Boolean | outName | Inherits name from base. |
| System.Boolean | outDescription | Inherits description from base. |
| System.Boolean | outCode | Inherits code from base. |
| System.Boolean | outPartNumber | Inherits part number from base. |
| System.Boolean | outComplementaryPartNumber | Inherits complementary part number from base. |
| System.Boolean | outManufacturer | Inherits complementary manufacturer from base. |
| System.Boolean | outManufacturerPartNumber | Inherits manufacturer part number from base. |
| System.Boolean | outComment | Inherits comment from base. |
| System.Collections.Generic.List<ElementId> | outOtherSystemParameters | Identifiers of other base document system parameters to inherit. |
| System.Boolean | outNonSystemParameters | Inherits non-system parameters from base. |
| System.Boolean | outPoints | Inherits points from base. |
| System.Boolean | outAxes | Inherits axes from base. |
| System.Boolean | outPlanes | Inherits planes from base. |
| System.Boolean | outFrames | Inherits frames from base. |
| System.Boolean | outSketches | Inherits sketches from base. |
| System.Boolean | outShapes | Inherits shapes from base. |
| System.Boolean | outPublishings | Inherits publishings from base. |
| System.Boolean | outFunctions | Inherits functions from base. |
| System.Boolean | outSymmetries | Inherits symmetries from base. |
| System.Boolean | outUnsectionabilities | Inherits unsectionabilities from base. |
| System.Boolean | outRepresentations | Inherits representations from base. |
| System.Boolean | outSets | Inherits sets from base. |
| System.Boolean | outCameras | Inherits cameras from base. |
Remarks
This method is available since v7.10.
GetInstanceFamilyDocument(DocumentId)
Gets the family document of an instance.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 17, 0, 0)]
DocumentId GetInstanceFamilyDocument(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the instance document. |
Returns
| Type | Description |
|---|---|
| DocumentId | The family document, return Empty if there is no family document or if inDOcument is not an instance. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.17.
GetPlaneSymmetry(ElementId, out SmartPlane3D)
Gets a plane symmetry.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
void GetPlaneSymmetry(ElementId inElementId, out SmartPlane3D outPlane)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the symmetry to analyze. |
| SmartPlane3D | outPlane | Symmetry plane. |
Remarks
This method is available since v7.10.
GetRevolutionSymmetry(ElementId, out SmartAxis3D)
Gets a revolution symmetry.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
void GetRevolutionSymmetry(ElementId inElementId, out SmartAxis3D outAxis)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the symmetry to analyze. |
| SmartAxis3D | outAxis | Symmetry axis. |
Remarks
This method is available since v7.10.
GetStockManagement(DocumentId, out StockManagementType, out DocumentId, out ElementId, out SmartText, out SmartText, out SmartText, out SmartText)
Declaration
[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
void GetStockManagement(DocumentId inDocumentId, out StockManagementType outType, out DocumentId outStockDocumentId, out ElementId outStockOccurrenceId, out SmartText outStockName, out SmartText outStockDescription, out SmartText outStockPartNumber, out SmartText outStockMajorRevision)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of part or assembly document to analyze. |
| StockManagementType | outType | Type of management. |
| DocumentId | outStockDocumentId | Stock document identifier, or empty if not of type Document. |
| ElementId | outStockOccurrenceId | Stock occurrence identifier, or empty if not of type Occurrence. |
| SmartText | outStockName | Stock name, or null if not of type Manual. |
| SmartText | outStockDescription | Stock description, or null if not of type Manual. |
| SmartText | outStockPartNumber | Stock part number, or null if not of type Manual. |
| SmartText | outStockMajorRevision | Stock major revision, or null if not of type Manual. |
Remarks
This method is available since v7.10.
GetStockManagement2(DocumentId, out StockManagementType, out DocumentId, out ElementId, out SmartText, out SmartText, out SmartText, out SmartText, out SmartText)
Gets the stock management of a part or assembly.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 11, 0, 0)]
void GetStockManagement2(DocumentId inDocumentId, out StockManagementType outType, out DocumentId outStockDocumentId, out ElementId outStockOccurrenceId, out SmartText outStockName, out SmartText outStockDescription, out SmartText outStockPartNumber, out SmartText outStockMajorRevision, out SmartText outStockDimensions)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of part or assembly document to analyze. |
| StockManagementType | outType | Type of management. |
| DocumentId | outStockDocumentId | Stock document identifier, or empty if not of type Document. |
| ElementId | outStockOccurrenceId | Stock occurrence identifier, or empty if not of type Occurrence. |
| SmartText | outStockName | Stock name, or null if not of type Manual. |
| SmartText | outStockDescription | Stock description, or null if not of type Manual. |
| SmartText | outStockPartNumber | Stock part number, or null if not of type Manual. |
| SmartText | outStockMajorRevision | Stock major revision, or null if not of type Manual. |
| SmartText | outStockDimensions | Stock dimensions, or null if not of type Manual. |
Remarks
This method is available since v7.11.
GetStockParameters(DocumentId, out ElementId, out ElementId, out ElementId, out ElementId)
Superseeded by GetStockParameters2(DocumentId, out ElementId, out ElementId, out ElementId, out ElementId, out ElementId).
Declaration
[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
void GetStockParameters(DocumentId inDocumentId, out ElementId outStockName, out ElementId outStockDescription, out ElementId outStockPartNumber, out ElementId outStockMajorRevision)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of part or assembly document to analyze. |
| ElementId | outStockName | Stock name text parameter entity identifier, or empty if not managed. |
| ElementId | outStockDescription | Stock description text parameter entity identifier, or empty if not managed. |
| ElementId | outStockPartNumber | Stock part number text parameter entity identifier, or empty if not managed. |
| ElementId | outStockMajorRevision | Stock major revision text parameter entity identifier, or empty if not managed. |
Remarks
This method is available since v7.10.
GetStockParameters2(DocumentId, out ElementId, out ElementId, out ElementId, out ElementId, out ElementId)
Gets the stock parameters of a part or assembly.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 11, 0, 0)]
void GetStockParameters2(DocumentId inDocumentId, out ElementId outStockName, out ElementId outStockDescription, out ElementId outStockPartNumber, out ElementId outStockMajorRevision, out ElementId outStockDimensions)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of part or assembly document to analyze. |
| ElementId | outStockName | Stock name text parameter entity identifier, or empty if not managed. |
| ElementId | outStockDescription | Stock description text parameter entity identifier, or empty if not managed. |
| ElementId | outStockPartNumber | Stock part number text parameter entity identifier, or empty if not managed. |
| ElementId | outStockMajorRevision | Stock major revision text parameter entity identifier, or empty if not managed. |
| ElementId | outStockDimensions | Stock dimensions text parameter entity identifier, or empty if not managed. |
Remarks
This method is available since v7.11.
GetSymmetries(DocumentId)
Gets the symmetry entities that are in the symmetries folder of a part or assembly document.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
List<ElementId> GetSymmetries(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<ElementId> | Symmetries entities found. |
Remarks
This method is available since v7.10.
GetSymmetryType(ElementId)
Gets the type of a symmetry entity.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
SymmetryType GetSymmetryType(ElementId inElementId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the element to analyze. |
Returns
| Type | Description |
|---|---|
| SymmetryType | Type of the symmetry, or None if the element is not a symmetry entity. |
Remarks
This method is available since v7.10.
InheritDetailingsElements(ElementId, EntityCopyNameMode, String)
Inherits the detailings elements of a node enttiy.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 16, 0, 0)]
ElementId InheritDetailingsElements(ElementId inElementToInheritDetailings, EntityCopyNameMode inEntityCopyNameMode, string inPrefixName)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementToInheritDetailings | Identifier of the element to inherit. |
| EntityCopyNameMode | inEntityCopyNameMode | The entity copy name mode. |
| System.String | inPrefixName | Prefix of the name of the created entity (only in PrefixedByCustomPrefix mode). |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the created detailing elements inheriting operation. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.16.
IsDerived(DocumentId)
Tells whether part or assembly is a derived part or assembly.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
bool IsDerived(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the part or assembly document to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The part or assembly is a derived part or assembly. |
Remarks
This method is available since v7.10.
IsMirror(DocumentId)
Tells whether part or assembly is a derived mirror.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
bool IsMirror(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the part or assembly document to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The part or assembly is a derived mirror. |
Remarks
This method is available since v7.10.
IsSymmetrical(DocumentId)
Tells whether part or assembly is symmetrical.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
bool IsSymmetrical(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the part or assembly document to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The part or assembly is symmetrical. |
Remarks
A part or assembly is symmetrical if it contains at least one symmetry entity.
Symmetrical parts and assemblies are not replaced by mirror parts or assemblies when making a mirror assembly of an assembly in which they are included.
This method is available since v7.10.
SearchMirrorDocument(DocumentId)
Searches for the derived mirror part or assembly of a specified part or assembly.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
DocumentId SearchMirrorDocument(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the part or assembly document to analyze. |
Returns
| Type | Description |
|---|---|
| DocumentId | Derived mirror part or assembly found, or Empty if not found. |
Remarks
This method is available since v7.10.
SearchSymmetricalDocument(DocumentId)
Searches for the symmetrical part or assembly of a specified part or assembly.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
DocumentId SearchSymmetricalDocument(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the part or assembly document to analyze. |
Returns
| Type | Description |
|---|---|
| DocumentId | Symmetrical part or assembly found, or Empty if not found. |
Remarks
If the specified part or assembly is symmetrical (i.e. IsSymmetrical(DocumentId) returns true), this method returns the
specified part or assembly.
Otherwise, if the specified part or assembly is a derived mirror, this method returns the base part or assembly.
Otherwise, if the specified part or assembly is the base part of a derived mirror part or assembly, this method returns the derived part or assembly.
Otherwise, this method returns Empty.
If there is no symmetrical part or assembly found, it will not be possible to make a mirror assembly of an assembly containing the specified part or assembly.
This method is available since v7.10.
SetCatalogCellCoatingValue(ElementId, ElementId, PdmMinorRevisionId)
Sets the coating value of the catalog cell.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 18, 400, 160)]
void SetCatalogCellCoatingValue(ElementId inRow, ElementId inParameterId, PdmMinorRevisionId inValueId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inRow | Identifier of the row. |
| ElementId | inParameterId | Identifier of the parameter of the column. |
| PdmMinorRevisionId | inValueId | Value of the cell. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.18.
SetCatalogCellFinishingValue(ElementId, ElementId, PdmMinorRevisionId)
Sets the finishing value of the catalog cell.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 18, 400, 160)]
void SetCatalogCellFinishingValue(ElementId inRow, ElementId inParameterId, PdmMinorRevisionId inValueId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inRow | Identifier of the row. |
| ElementId | inParameterId | Identifier of the parameter of the column. |
| PdmMinorRevisionId | inValueId | Value of the cell. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.18.
SetCatalogCellMaterialValue(ElementId, ElementId, PdmMinorRevisionId)
Sets the material value of the catalog cell.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 18, 400, 160)]
void SetCatalogCellMaterialValue(ElementId inRow, ElementId inParameterId, PdmMinorRevisionId inValueId)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inRow | Identifier of the row. |
| ElementId | inParameterId | Identifier of the parameter of the column. |
| PdmMinorRevisionId | inValueId | Value of the cell. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.18.
SetDerivationInheritances(DocumentId, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, List<ElementId>, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean)
Sets the derivation inheritances of a derived part or assembly.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
void SetDerivationInheritances(DocumentId inDocumentId, bool inName, bool inDescription, bool inCode, bool inPartNumber, bool inComplementaryPartNumber, bool inManufacturer, bool inManufacturerPartNumber, bool inComment, List<ElementId> inOtherSystemParameters, bool inNonSystemParameters, bool inPoints, bool inAxes, bool inPlanes, bool inFrames, bool inSketches, bool inShapes, bool inPublishings, bool inFunctions, bool inSymmetries, bool inUnsectionabilities, bool inRepresentations, bool inSets, bool inCameras)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of derived part or assembly document to modify. |
| System.Boolean | inName | Inherits name from base. |
| System.Boolean | inDescription | Inherits description from base. |
| System.Boolean | inCode | Inherits code from base. |
| System.Boolean | inPartNumber | Inherits part number from base. |
| System.Boolean | inComplementaryPartNumber | Inherits complementary part number from base. |
| System.Boolean | inManufacturer | Inherits complementary manufacturer from base. |
| System.Boolean | inManufacturerPartNumber | Inherits manufacturer part number from base. |
| System.Boolean | inComment | Inherits comment from base. |
| System.Collections.Generic.List<ElementId> | inOtherSystemParameters | Identifiers of other base document system parameters to inherit. |
| System.Boolean | inNonSystemParameters | Inherits non-system parameters from base. |
| System.Boolean | inPoints | Inherits points from base. |
| System.Boolean | inAxes | Inherits axes from base. |
| System.Boolean | inPlanes | Inherits planes from base. |
| System.Boolean | inFrames | Inherits frames from base. |
| System.Boolean | inSketches | Inherits sketches from base. |
| System.Boolean | inShapes | Inherits shapes from base. |
| System.Boolean | inPublishings | Inherits publishings from base. |
| System.Boolean | inFunctions | Inherits functions from base. |
| System.Boolean | inSymmetries | Inherits symmetries from base. |
| System.Boolean | inUnsectionabilities | Inherits unsectionabilities from base. |
| System.Boolean | inRepresentations | Inherits representations from base. |
| System.Boolean | inSets | Inherits sets from base. |
| System.Boolean | inCameras | Inherits cameras from base. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.10.
SetPlaneSymmetry(ElementId, SmartPlane3D)
Sets a plane symmetry.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
void SetPlaneSymmetry(ElementId inElementId, SmartPlane3D inPlane)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the symmetry to modify. |
| SmartPlane3D | inPlane | Symmetry plane. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.10.
SetRevolutionSymmetry(ElementId, SmartAxis3D)
Sets a revolution symmetry.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
void SetRevolutionSymmetry(ElementId inElementId, SmartAxis3D inAxis)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the symmetry to modify. |
| SmartAxis3D | inAxis | Symmetry axis. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.10.
SetStockManagement(DocumentId, StockManagementType, DocumentId, ElementId, SmartText, SmartText, SmartText, SmartText)
Superseeded by SetStockManagement2(DocumentId, StockManagementType, DocumentId, ElementId, SmartText, SmartText, SmartText, SmartText, SmartText).
Declaration
[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
void SetStockManagement(DocumentId inDocumentId, StockManagementType inType, DocumentId inStockDocumentId, ElementId inStockOccurrenceId, SmartText inStockName, SmartText inStockDescription, SmartText inStockPartNumber, SmartText inStockMajorRevision)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of part or assembly document to modify. |
| StockManagementType | inType | Type of management. |
| DocumentId | inStockDocumentId | Stock document identifier, or empty if not of type Document. |
| ElementId | inStockOccurrenceId | Stock occurrence identifier, or empty if not of type Occurrence. |
| SmartText | inStockName | Stock name, or null if not of type Manual. |
| SmartText | inStockDescription | Stock description, or null if not of type Manual. |
| SmartText | inStockPartNumber | Stock part number, or null if not of type Manual. |
| SmartText | inStockMajorRevision | Stock major revision, or null if not of type Manual. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.10.
SetStockManagement2(DocumentId, StockManagementType, DocumentId, ElementId, SmartText, SmartText, SmartText, SmartText, SmartText)
Sets the stock management of a part or assembly.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 11, 0, 0)]
void SetStockManagement2(DocumentId inDocumentId, StockManagementType inType, DocumentId inStockDocumentId, ElementId inStockOccurrenceId, SmartText inStockName, SmartText inStockDescription, SmartText inStockPartNumber, SmartText inStockMajorRevision, SmartText inStockDimensions)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of part or assembly document to modify. |
| StockManagementType | inType | Type of management. |
| DocumentId | inStockDocumentId | Stock document identifier, or empty if not of type Document. |
| ElementId | inStockOccurrenceId | Stock occurrence identifier, or empty if not of type Occurrence. |
| SmartText | inStockName | Stock name, or null if not of type Manual. |
| SmartText | inStockDescription | Stock description, or null if not of type Manual. |
| SmartText | inStockPartNumber | Stock part number, or null if not of type Manual. |
| SmartText | inStockMajorRevision | Stock major revision, or null if not of type Manual. |
| SmartText | inStockDimensions | Stock dimensions, or null if not of type Manual. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.11.