Interface IDraftings

Gives access to drafting documents.

Namespace: TopSolid.Cad.Drafting.Automating

Assembly: TopSolid.Cad.Drafting.Automating.dll

Syntax

[ServiceContract]
[AvailableSinceVersion(7, 10, 0, 0)]
public interface IDraftings

Remarks

This interface is available since v7.10.

Methods

CreateDocument(PdmObjectId, DocumentId, DocumentId)

Creates a drafting document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
PdmObjectId CreateDocument(PdmObjectId inContainerId, DocumentId inTemplateId, DocumentId inSourceId)

Parameters

Type	Name	Description
PdmObjectId	inContainerId	Identifier of container.
DocumentId	inTemplateId	Template document.
DocumentId	inSourceId	Source document.

Returns

Type	Description
PdmObjectId

Remarks

This method is available since v7.10.

CreateLinearDimensionBetweenTwoPoints(ElementId, Point2D, Point2D, Direction2D, String, String)

Creates a linear dimension using two points.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 19, 180, 0)]
ElementId CreateLinearDimensionBetweenTwoPoints(ElementId inElementId, Point2D inFirstPoint, Point2D inSecondPoint, Direction2D inDirection, string inPrefix, string inSuffix)

Parameters

Type	Name	Description
ElementId	inElementId	Drafting view id.
Point2D	inFirstPoint	First point of the dimension.
Point2D	inSecondPoint	Second point of the dimension.
Direction2D	inDirection	Display vector of the dimension.
String	inPrefix	Prefix to add, or empty if no prefix.
String	inSuffix	Suffix to add, or empty if no suffix.

Returns

Type	Description
ElementId

Remarks

This method is available since v7.19.

GetDraftingDimensions(ElementId)

Gets dimensions from a drafting document view.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 19, 180, 0)]
List<ElementId> GetDraftingDimensions(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Drafting view.

Returns

Type	Description
List<ElementId>

Remarks

This method is available since v7.19.

GetDraftingViews(DocumentId)

Gets the views from a drafting document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 19, 180, 0)]
List<ElementId> GetDraftingViews(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Drafting document.

Returns

Type	Description
List<ElementId>

Remarks

This method is available since v7.19.

GetProjectionMode(DocumentId)

Gets the projection mode of a drafting document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
ProjectionMode GetProjectionMode(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Document to analyze.

Returns

Type	Description
ProjectionMode	Projection mode.

Remarks

This method is available since v7.8.303.120.

GetScaleFactorParameter(DocumentId)

Gets the scale factor parameter entity of a document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
ElementId GetScaleFactorParameter(DocumentId inDocumentId)

Parameters

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

Returns

Type	Description
ElementId	Identifier of the scale factor parameter entity found.

Remarks

This method is available since v7.10.

GetScaleFactorParameterValue(DocumentId)

Gets the scale factor parameter entity value of a document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 15, 400, 240)]
double GetScaleFactorParameterValue(DocumentId inDocumentId)

Parameters

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

Returns

Type	Description
Double	Value of the scale factor parameter entity found.

Remarks

This method is available since v7.15.400.240.

IsDrafting(DocumentId)

Tells whether a document is a drafting document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
bool IsDrafting(DocumentId inDocumentId)

Parameters

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

Returns

Type	Description
Boolean	The document is a drafting document.

Remarks

This method is available since v7.10.

MultiplePrint(List<DocumentId>, PrintMode, PrintColorMapping, Int32)

Prints a list of documents to the printers according to the draft formats.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
void MultiplePrint(List<DocumentId> inDocumentIds, PrintMode inMode, PrintColorMapping inColorMapping, int inResolution)

Parameters

Type	Name	Description
List<DocumentId>	inDocumentIds	Documents to print.
PrintMode	inMode	Print mode.
PrintColorMapping	inColorMapping	Color conversion mode.
Int32	inResolution	Print resolution in dot-per-inch.

Remarks

This method is available since v7.10.

Print(DocumentId, PrintMode, PrintColorMapping, Int32, Int32, Int32)

Prints a document to the active printer.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
void Print(DocumentId inDocumentId, PrintMode inMode, PrintColorMapping inColorMapping, int inResolution, int inFromPage, int inToPage)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Document to print.
PrintMode	inMode	Print mode.
PrintColorMapping	inColorMapping	Color conversion mode.
Int32	inResolution	Print resolution in dot-per-inch.
Int32	inFromPage	Start page to print (or -1 to print all pages).
Int32	inToPage	End page to print.

Remarks

This method is available since v7.10.

SetProjectionMode(DocumentId, ProjectionMode)

Sets the projection mode of a drafting document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 10, 0, 0)]
void SetProjectionMode(DocumentId inDocumentId, ProjectionMode inProjectionMode)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Document to modify.
ProjectionMode	inProjectionMode	New projection mode.

Remarks

This method is available since v7.10.

SetScaleFactorParameterValue(DocumentId, Double)

Sets the scale factor parameter entity value of a document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 15, 400, 240)]
void SetScaleFactorParameterValue(DocumentId inDocumentId, double inAbsoluteValue)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
Double	inAbsoluteValue	Value of the scale factor.

Remarks

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

This method is available since v7.15.400.240.