ASD Drafting Types Methods

This page discusses:

ASDAttributeSet.AttributeType()

Signature

ASDAttributeSet.AttributeType(Name : String) : String

Arguments

Name Input/Output Required? Type Comment
Name In String -

ReturnType

String

ASDAttributeSet.GetAttributeBoolean()

Signature

ASDAttributeSet.GetAttributeBoolean(Name : String) : Boolean

Arguments

Name Input/Output Required? Type Comment
Name In String -

ReturnType

Boolean

ASDAttributeSet.GetAttributeInteger()

Signature

ASDAttributeSet.GetAttributeInteger(Name : String) : Integer

Arguments

Name Input/Output Required? Type Comment
Name In String -

ReturnType

Integer

ASDAttributeSet.GetAttributeReal()

Signature

ASDAttributeSet.GetAttributeReal(Name : String) : Real

Arguments

Name Input/Output Required? Type Comment
Name In String -

ReturnType

Real

ASDAttributeSet.GetAttributeString()

Signature

ASDAttributeSet.GetAttributeString(Name : String) : String

Arguments

Name Input/Output Required? Type Comment
Name In String -

ReturnType

String

ASDAttributeSet.HasAttribute()

Signature

ASDAttributeSet.HasAttribute(Name : String) : Boolean

Arguments

Name Input/Output Required? Type Comment
Name In String -

ReturnType

Boolean

ASDAttributeSet.ListAttributeNames()

Signature

ASDAttributeSet.ListAttributeNames() : List

ReturnType

List

ASDBox.IsFullyInside()

ASDBox-IsFullyInside verifies if an object is fully inside the view box.

Signature

ASDBox.IsFullyInside(iObject : Feature, oIsFullyInside : Boolean) : Boolean

Arguments

Name Input/Output Required? Type Comment
iObject In Feature

The object for which the check is performed. Only ProductOccurrence objects are supported.

oIsFullyInside Out Boolean

Result

ReturnType

Boolean

ASDGenerativeTable.QueryTableDataUsingOccurrence()

Signature

ASDGenerativeTable.QueryTableDataUsingOccurrence(Occurrence : ProductOccurrence, Column : Integer) : String

Arguments

Name Input/Output Required? Type Comment
Occurrence In ProductOccurrence -
Column In Integer -

ReturnType

String

ASDSpecDrawing.GetDrawingStandard()

ASDSpecDrawing-GetDrawingStandard returns the name of the drawing standard stored in the ASDSpecDrawing object.

Signature

ASDSpecDrawing.GetDrawingStandard(oDrawingStandardName : String) : Boolean

Arguments

Name Input/Output Required? Type Comment
oDrawingStandardName Out String The name of the drawing standard.

ReturnType

Boolean

ASDSpecDrawing.SetDrawingStandard()

ASDSpecDrawing-SetDrawingStandard specifies the provided drawing standard to the ASDSpecDrawing object.

Signature

ASDSpecDrawing.SetDrawingStandard(iDrawingStandardName : String) : Boolean

Arguments

Name Input/Output Required? Type Comment
iDrawingStandardName In String The name of the drawing standard.

ReturnType

Boolean

ASDSpecFrontView.GetProjectionPlane()

ASDSpecFrontView-GetProjectionPlane() function returns the projection plane info stored in the view's specification.

Signature

ASDSpecFrontView.GetProjectionPlane(oOriginX : Real, oOriginY : Real, oOriginZ : Real, oFirstDirectionX : Real, oFirstDirectionY : Real, oFirstDirectionZ : Real, oSecondDirectionX : Real, oSecondDirectionY : Real, oSecondDirectionZ : Real) : Boolean

Arguments

Name Input/Output Required? Type Comment
oOriginX Out Real

X coordinate for Origin.

oOriginY Out Real

Y coordinate for Origin.

oOriginZ Out Real

Z coordinate for Origin.

oFirstDirectionX Out Real

X coordinate for First Direction.

oFirstDirectionY Out Real

Y coordinate for First Direction.

oFirstDirectionZ Out Real

Z coordinate for First Direction.

oSecondDirectionX Out Real

X coordinate for Second Direction.

oSecondDirectionY Out Real

Y coordinate for Second Direction.

oSecondDirectionZ Out Real

Z coordinate for Second Direction.

ReturnType

Boolean

ASDSpecFrontView.GetViewTemplate()

ASDSpecFrontView-GetViewTemplate() function returns the name of the View Template stored in the view's specification.

Signature

ASDSpecFrontView.GetViewTemplate(oViewTemplateName : String) : Boolean

Arguments

Name Input/Output Required? Type Comment
oViewTemplateName Out String The template name.

ReturnType

Boolean

ASDSpecFrontView.SetProjectionPlane()

ASDSpecFrontView-SetProjectionPlane() function specifies the projection plane info to the view's specification based on the iOriginMode.

Signature

ASDSpecFrontView.SetProjectionPlane(iOriginMode : Integer, iPointX : Real, iPointY : Real, iPointZ : Real, iFirstDirectionX : Real, iFirstDirectionY : Real, iFirstDirectionZ : Real, iSecondDirectionX : Real, iSecondDirectionY : Real, iSecondDirectionZ : Real) : Boolean

Arguments

Name Input/Output Required? Type Comment
iOriginMode In Integer

Supported Values:

  • 0: Origin is the point provided to the SetProjectionPlane() method.
  • 1: Origin is the global (0,0,0).
  • 2: Origin is the global (0,0,0) projected on the plane.

iPointX In Real

X coordinate of the Origin.

iPointY In Real

Y coordinate of the Origin.

iPointZ In Real

Z coordinate of the Origin.

iFirstDirectionX In Real

X coordinate of the First Direction.

iFirstDirectionY In Real

Y coordinate of the First Direction.

iFirstDirectionZ In Real

Z coordinate of the First Direction.

iSecondDirectionX In Real

X coordinate of the Second Direction.

iSecondDirectionY In Real

Y coordinate of the Second Direction.

iSecondDirectionZ In Real

Z coordinate of the Second Direction.

ReturnType

Boolean

ASDSpecFrontView.SetViewTemplate()

ASDSpecFrontView-SetViewTemplate() function specifies the provided view template to the view's specification using the template name.

Signature

ASDSpecFrontView.SetViewTemplate(iViewTemplateName : String) : Boolean

Arguments

Name Input/Output Required? Type Comment
iViewTemplateName In String The template name.

ReturnType

Boolean

ASDSpecGenViewAbstract.AddNewViewBoxSpec()

ASDSpecGenViewAbstract-AddNewViewBoxSpec() function adds a new ASDSpecViewBox to this ASDSpecGenViewAbstract object.

Signature

ASDSpecGenViewAbstract.AddNewViewBoxSpec(oViewBoxSpec : ASDSpecViewBox) : Boolean

Arguments

Name Input/Output Required? Type Comment
oViewBoxSpec Out ASDSpecViewBox The view box specification that is created for the view.

ReturnType

Boolean

ASDSpecGenViewAbstract.GetViewBoxSpecs()

ASDSpecGenViewAbstract-GetViewBoxSpecs() function gets the list of all ASDSpecViewBox associated with this ASDSpecGenViewAbstract object.

Signature

ASDSpecGenViewAbstract.GetViewBoxSpecs(oListViewBoxSpecs : List) : Boolean

Arguments

Name Input/Output Required? Type Comment
oListViewBoxSpecs Out List The list of all ASDSpecViewBox associated with this object.

ReturnType

Boolean

ASDSpecSheet.GetSheetTemplate()

ASDSpecSheet-GetSheetTemplate() function returns the name of the sheet template stored in the ASDSpecSheet object.

Signature

ASDSpecSheet.GetSheetTemplate(oSheetTemplateName : String) : Boolean

Arguments

Name Input/Output Required? Type Comment
oSheetTemplateName Out String The template name.

ReturnType

Boolean

ASDSpecSheet.SetSheetTemplate()

ASDSpecSheet-SetSheetTemplate() function specifies a provided sheet template to the ASDSpecSheet object using the template name.

Signature

ASDSpecSheet.SetSheetTemplate(iSheetTemplateName : String) : Boolean

Arguments

Name Input/Output Required? Type Comment
iSheetTemplateName In String The template name.

ReturnType

Boolean

ASDSpecSheetAbstract.GetParentDrawing()

ASDSpecSheetAbstract-GetParentDrawing() function returns the parent drawing stored in the ASDSpecSheetAbstract object.

Signature

ASDSpecSheetAbstract.GetParentDrawing(oParentDrawing : DrwDrawing) : Boolean

Arguments

Name Input/Output Required? Type Comment
oParentDrawing Out DrwDrawing The parent drawing.

ReturnType

Boolean

ASDSpecStructuralView.GetProjectionPlane()

ASDSpecStructuralView-GetProjectionPlane() function returns the projection plane info stored in the view's specification.

Signature

ASDSpecStructuralView.GetProjectionPlane
(oOriginX : Real, 
oOriginY : Real, 
oOriginZ : Real, 
oFirstDirectionX : Real, 
oFirstDirectionY : Real, 
oFirstDirectionZ : Real, 
oSecondDirectionX : Real, 
oSecondDirectionY : Real, 
oSecondDirectionZ : Real) : Boolean

Arguments

Name Input/Output Required? Type Comment
oOriginX Out Real

X coordinate for Origin.

oOriginY Out Real

Y coordinate for Origin.

oOriginZ Out Real

Z coordinate for Origin.

oFirstDirectionX Out Real

X coordinate for First Direction.

oFirstDirectionY Out Real

Y coordinate for First Direction.

oFirstDirectionZ Out Real

Z coordinate for First Direction.

oSecondDirectionX Out Real

X coordinate for Second Direction.

oSecondDirectionY Out Real

Y coordinate for Second Direction.

oSecondDirectionZ Out Real

Z coordinate for Second Direction.

ReturnType

Boolean

ASDSpecStructuralView.GetViewTemplate()

ASDSpecStructuralView-GetViewTemplate() function returns the name of the view template stored in the view's specification.

Signature

ASDSpecStructuralView.GetViewTemplate(oViewTemplateName : String) : Boolean

Arguments

Name Input/Output Required? Type Comment
oViewTemplateName Out String The template name.

ReturnType

Boolean

ASDSpecStructuralView.SetProjectionPlane()

ASDSpecStructuralView-SetProjectionPlane() function specifies the projection plane info to the view's specification based on the iOriginMode.

Signature

ASDSpecStructuralView.SetProjectionPlane(iOriginMode : Integer, iPointX : Real, iPointY : Real, iPointZ : Real, iFirstDirectionX : Real, iFirstDirectionY : Real, iFirstDirectionZ : Real, iSecondDirectionX : Real, iSecondDirectionY : Real, iSecondDirectionZ : Real) : Boolean

Arguments

Name Input/Output Required? Type Comment
iOriginMode In Integer

Supported Values:

  • 0: Origin is the point provided to the SetProjectionPlane() method.
  • 1: Origin is the global (0,0,0).
  • 2: Origin is the global (0,0,0) projected on the plane.

iPointX In Real

X coordinate of the Origin.

iPointY In Real

Y coordinate of the Origin.

iPointZ In Real

Z coordinate of the Origin.

iFirstDirectionX In Real

X coordinate of the First Direction.

iFirstDirectionY In Real

Y coordinate of the First Direction.

iFirstDirectionZ In Real

Z coordinate of the First Direction.

iSecondDirectionX In Real

X coordinate of the Second Direction.

iSecondDirectionY In Real

Y coordinate of the Second Direction.

iSecondDirectionZ In Real

Z coordinate of the Second Direction.

ReturnType

Boolean

ASDSpecStructuralView.SetViewTemplate()

ASDSpecStructuralView-SetViewTemplate() function specifies the provided view template to the view's specification using the template name.

Signature

ASDSpecStructuralView.SetViewTemplate(iViewTemplateName : String) : Boolean

Arguments

Name Input/Output Required? Type Comment
iViewTemplateName In String The template name.

ReturnType

Boolean

ASDSpecViewAbstract.CreateViewPositionAlignment()

ASDSpecViewAbstract-CreateViewPositionAlignment() function creates a new spec of view position alignment for this view's specification.

Signature

ASDSpecViewAbstract.CreateViewPositionAlignment(oViewPositionSpec : ASDSpecViewPositionAlignment) : Boolean

Arguments

Name Input/Output Required? Type Comment
oViewPositionSpec Out ASDSpecViewPositionAlignment The SpecViewPositionalAlignment created for this view.

ReturnType

Boolean

ASDSpecViewAbstract.GetParentSheet()

ASDSpecViewAbstract-GetParentSheet() function returns the parent sheet stored in the ASDSpecViewAbstract object.

Signature

ASDSpecViewAbstract.GetParentSheet(oParentSheet : DrwSheet) : Boolean

Arguments

Name Input/Output Required? Type Comment
oParentSheet Out DrwSheet The parent sheet.

ReturnType

Boolean

ASDSpecViewAbstract.GetViewAxisPosition()

ASDSpecViewAbstract-GetViewAxisPosition() function returns the view axis position stored in the view's specification.

Signature

ASDSpecViewAbstract.GetViewAxisPosition(oX : Real, oY : Real) : Boolean

Arguments

Name Input/Output Required? Type Comment
oX Out Real

X coordinate of the view axis position.

oY Out Real

Y coordinate of the view axis position.

ReturnType

Boolean

ASDSpecViewAbstract.GetViewPositionAlignment()

ASDSpecViewAbstract-GetViewPositionAlignment() function gets the spec of view position alignment stored on this view's specification.

Signature

ASDSpecViewAbstract.GetViewPositionAlignment(oViewPositionSpec : ASDSpecViewPositionAlignment) : Boolean

Arguments

Name Input/Output Required? Type Comment
oViewPositionSpec Out ASDSpecViewPositionAlignment The SpecViewPositionalAlignment stored on this view.

ReturnType

Boolean

ASDSpecViewAbstract.SetViewAxisPosition()

ASDSpecViewAbstract-SetViewAxisPosition() function specifies a view axis position to the view's specification.

Signature

ASDSpecViewAbstract.SetViewAxisPosition(iX : Real, iY : Real) : Boolean

Arguments

Name Input/Output Required? Type Comment
iX In Real

X coordinate of the view axis position.

iY In Real

Y coordinate of the view axis position.

ReturnType

Boolean

ASDSpecViewBox.GetFarLimit()

ASDSpecViewBox-GetFarLimit() function gets the Far Limits from the ViewBox specification.

Signature

ASDSpecViewBox.GetFarLimit(oLimit : Integer) : Boolean

Arguments

Name Input/Output Required? Type Comment
oLimit Out Integer

Supported Integer Values:

  • 0: IncludedObjects
  • 1: ViewLinks

ReturnType

Boolean

ASDSpecViewBox.GetFarOffset()

ASDSpecViewBox-GetFarOffset() function gets the Far Offset from the ViewBox specification.

Signature

ASDSpecViewBox.GetFarOffset(oOffset : Real) : Boolean

Arguments

Name Input/Output Required? Type Comment
oOffset Out Real Default offset is 0mm.

ReturnType

Boolean

ASDSpecViewBox.GetNearLimit()

ASDSpecViewBox-GetNearLimit() function gets the Near Limits from the ViewBox specification.

Signature

ASDSpecViewBox.GetNearLimit(oLimit : Integer) : Boolean

Arguments

Name Input/Output Required? Type Comment
oLimit Out Integer

Supported Integer Values:

  • 0: IncludedObjects
  • 1: ViewLinks

ReturnType

Boolean

ASDSpecViewBox.GetNearOffset()

ASDSpecViewBox-GetNearOffset() function gets the Near Offset from the ViewBox specification.

Signature

ASDSpecViewBox.GetNearOffset(oOffset : Real) : Boolean

Arguments

Name Input/Output Required? Type Comment
oOffset Out Real Default offset is 0mm.

ReturnType

Boolean

ASDSpecViewBox.GetObjects()

ASDSpecViewBox-GetObjects() function gets the Objects from the ViewBox specification. (Only Product Occurrences are supported).

Signature

ASDSpecViewBox.GetObjects(oListObjects : List, oKeepLinks : Boolean) : Boolean

Arguments

Name Input/Output Required? Type Comment
oListObjects Out List List of Objects included in the box. Only Product Occurrences are supported.
oKeepLinks Out Boolean

Boolean flag to tell if the box must keep a persistent link on the objects.

ReturnType

Boolean

ASDSpecViewBox.GetOperationType()

ASDSpecViewBox-GetOperationType() function gets the Operation Type from the ViewBox specification.

Signature

ASDSpecViewBox.GetOperationType(oOperationType : Integer) : Boolean

Arguments

Name Input/Output Required? Type Comment
oOperationType Out Integer

Supported Integer Values:

  • 0: IntersectionFilter
  • 1: FullyInsideFilter
  • 2: 3DClipping

ReturnType

Boolean

ASDSpecViewBox.GetOrientationMode()

ASDSpecViewBox-GetOrientationMode() function gets the Orientation Mode from the ViewBox specification.

Signature

ASDSpecViewBox.GetOrientationMode(oOrientationMode : Integer) : Boolean

Arguments

Name Input/Output Required? Type Comment
oOrientationMode Out Integer

Supported Integer Values:

  • 0: GlobalAxis
  • 1: MinBoundingBoxOfAllIncludedObjects
  • 2: MinBoundingBoxOfFirstIncludedObjects

ReturnType

Boolean

ASDSpecViewBox.GetSideLimits()

ASDSpecViewBox-GetSideLimits() function gets the Side Limits from the ViewBox specification.

Signature

ASDSpecViewBox.GetSideLimits(oLimit : Integer) : Boolean

Arguments

Name Input/Output Required? Type Comment
oLimit Out Integer

Supported Integer Values:

  • 0: IncludedObjects
  • 1: ViewLinks

ReturnType

Boolean

ASDSpecViewBox.GetSideOffsets()

ASDSpecViewBox-GetSideOffsets() function gets the Side Offsets from the ViewBox specification.

Signature

ASDSpecViewBox.GetSideOffsets(oOffset : Real) : Boolean

Arguments

Name Input/Output Required? Type Comment
oOffset Out Real Default offset is 0mm.

ReturnType

Boolean

ASDSpecViewBox.SetFarLimit()

ASDSpecViewBox-SetFarLimit() function specifies the Far Limits to the ViewBox specification.

Signature

ASDSpecViewBox.SetFarLimit(iLimit : Integer) : Boolean

Arguments

Name Input/Output Required? Type Comment
iLimit In Integer

Supported Integer Values:

  • 0: IncludedObjects
  • 1: ViewLinks

ReturnType

Boolean

ASDSpecViewBox.SetFarOffset()

ASDSpecViewBox-SetFarOffset() function specifies the Far Offset to the ViewBox specification.

Signature

ASDSpecViewBox.SetFarOffset(iOffset : Real) : Boolean

Arguments

Name Input/Output Required? Type Comment
iOffset In Real Default offset is 0mm.

ReturnType

Boolean

ASDSpecViewBox.SetNearLimit()

ASDSpecViewBox-SetNearLimit() function sets Near Limits to the ViewBox specification.

Signature

ASDSpecViewBox.SetNearLimit(iLimit : Integer) : Boolean

Arguments

Name Input/Output Required? Type Comment
iLimit In Integer

Supported Integer Values:

  • 0: IncludedObjects
  • 1: ViewLinks

ReturnType

Boolean

ASDSpecViewBox.SetNearOffset()

ASDSpecViewBox-SetNearOffset() function sets Near Offset to ViewBox specification.

Signature

ASDSpecViewBox.SetNearOffset(iOffset : Real) : Boolean

Arguments

Name Input/Output Required? Type Comment
iOffset In Real Default offset is 0mm.

ReturnType

Boolean

ASDSpecViewBox.SetObjects()

ASDSpecViewBox-SetObjects() function specifies objects to the ViewBox specification. (Only Product Occurrences are supported).

Signature

ASDSpecViewBox.SetObjects(iListObjects : List, iKeepLinks : Boolean) : Boolean

Arguments

Name Input/Output Required? Type Comment
iListObjects In List List of Objects included in the box. Only Product Occurrences are supported.
iKeepLinks In Boolean Boolean flag to tell if the box must keep a persistent link on the objects.

ReturnType

Boolean

ASDSpecViewBox.SetOperationType()

ASDSpecViewBox-SetOperationType() function specifies Operation Type to the ViewBox specification.

Signature

ASDSpecViewBox.SetOperationType(iOperationType : Integer) : Boolean

Arguments

Name Input/Output Required? Type Comment
iOperationType In Integer

Supported Integer Values:

  • 0: IntersectionFilter
  • 1: FullyInsideFilter
  • 2: 3DClipping

ReturnType

Boolean

ASDSpecViewBox.SetOrientationMode()

ASDSpecViewBox-SetOrientationMode() function specifies Orientation Mode to the ViewBox specification.

Signature

ASDSpecViewBox.SetOrientationMode(iOrientationMode : Integer) : Boolean

Arguments

Name Input/Output Required? Type Comment
iOrientationMode In Integer

Supported Integer Values:

  • 0: GlobalAxis
  • 1: MinBoundingBoxOfAllIncludedObjects
  • 2: MinBoundingBoxOfFirstIncludedObjects

ReturnType

Boolean

ASDSpecViewBox.SetSideLimits()

ASDSpecViewBox-SetSideLimits() function specifies the Side Limits to the ViewBox specification.

Signature

ASDSpecViewBox.SetSideLimits(iLimit : Integer) : Boolean

Arguments

Name Input/Output Required? Type Comment
iLimit In Integer

Supported Integer Values:

  • 0: IncludedObjects
  • 1: ViewLinks

ReturnType

Boolean

ASDSpecViewBox.SetSideOffsets()

ASDSpecViewBox-SetSideOffsets() function specifies Side Offsets to the ViewBox specification.

Signature

ASDSpecViewBox.SetSideOffsets(iOffset : Real) : Boolean

Arguments

Name Input/Output Required? Type Comment
iOffset In Real Default offset is 0mm.

ReturnType

Boolean

ASDSpecViewPositionAlignment.GetDirections()

ASDSpecViewPositionAlignment-GetDirections() function gets the directions used to the view alignment specification.

Signature

ASDSpecViewPositionAlignment.GetDirections(oFirstDir : Integer, oSecondDir  : Integer) : Boolean

Arguments

Name Input/Output Required? Type Comment
oFirstDir Out Integer

Supported Integer Values:

  • 0: TopToBottom
  • 1: BottomToTop
  • 2: LeftToRight
  • 3: RightToLeft

oSecondDir Out Integer

Supported Integer Values:

  • 0: TopToBottom
  • 1: BottomToTop
  • 2: LeftToRight
  • 3: RightToLeft

ReturnType

Boolean

ASDSpecViewPositionAlignment.GetSheetMargins()

ASDSpecViewPositionAlignment-GetSheetMargins() function gets the sheet margins used to the view alignment specification.

Signature

ASDSpecViewPositionAlignment.GetSheetMargins(oMarginX : Real, oMarginY : Real) : Boolean

Arguments

Name Input/Output Required? Type Comment
oMarginX Out Real

The horizontal margin for the sheet.

oMarginY Out Real

The vertical margin for the sheet.

ReturnType

Boolean

ASDSpecViewPositionAlignment.GetStartAnchor()

ASDSpecViewPositionAlignment-GetStartAnchor() function gets the start anchor of the view alignment specification.

Signature

ASDSpecViewPositionAlignment.GetStartAnchor(oAnchor : Integer) : Boolean

Arguments

Name Input/Output Required? Type Comment
oAnchor Out Integer

Supported Integer Values:

  • 0: TopLeftOfSheet
  • 1: TopRightOfSheet
  • 2: BottomLeftOfSheet
  • 3: BottomRightOfSheet

ReturnType

Boolean

ASDSpecViewPositionAlignment.GetViewOffsets()

ASDSpecViewPositionAlignment-GetViewOffsets() function gets the view offsets used to the view alignment specification.

Signature

ASDSpecViewPositionAlignment.GetViewOffsets(oOffsetX : Real, oOffsetY : Real) : Boolean

Arguments

Name Input/Output Required? Type Comment
oOffsetX Out Real

The horizontal offset.

oOffsetY Out Real

The vertical offset.

ReturnType

Boolean

ASDSpecViewPositionAlignment.SetDirections()

ASDSpecViewPositionAlignment-SetDirections() function specifies the directions used to the view alignment specification. The default behavior is TopToBottom/LeftToRight.

Only the combination TopToBottom / LeftToRight is supported for the moment.

Signature

ASDSpecViewPositionAlignment.SetDirections(iFirstDir : Integer, iSecondDir  : Integer) : Boolean

Arguments

Name Input/Output Required? Type Comment
iFirstDir In Integer

Supported Integer Values:

  • 0: TopToBottom
  • 1: BottomToTop
  • 2: LeftToRight
  • 3: RightToLeft

iSecondDir In Integer

Supported Integer Values:

  • 0: TopToBottom
  • 1: BottomToTop
  • 2: LeftToRight
  • 3: RightToLeft

iFirstDir and iSecondDir cannot have the same values.

ReturnType

Boolean

ASDSpecViewPositionAlignment.SetSheetMargins()

ASDSpecViewPositionAlignment-SetSheetMargins() function specifies the sheet margins used to the view alignment specification. Default margins are of 0mm.

Signature

ASDSpecViewPositionAlignment.SetSheetMargins(iMarginX : Real, iMarginY : Real) : Boolean

Arguments

Name Input/Output Required? Type Comment
iMarginX In Real

The horizontal margin for the sheet.

iMarginY In Real

The vertical margin for the sheet.

ReturnType

Boolean

ASDSpecViewPositionAlignment.SetStartAnchor()

ASDSpecViewPositionAlignment-SetStartAnchor() function specifies the start anchor of the view alignment specification.

Signature

ASDSpecViewPositionAlignment.SetStartAnchor(iAnchor : Integer) : Boolean

Arguments

Name Input/Output Required? Type Comment
iAnchor In Integer

Supported Integer Values:

  • 0: TopLeftOfSheet
  • 1: TopRightOfSheet
  • 2: BottomLeftOfSheet
  • 3: BottomRightOfSheet

Default behavior: TopLeftOfSheet (taking into account the potential sheet margin X and sheet margin Y.)

ReturnType

Boolean

ASDSpecViewPositionAlignment.SetViewOffsets()

ASDSpecViewPositionAlignment-SetViewOffsets() function specifies the view offsets used to the view alignment spec. Default offsets are 0mm.

Signature

ASDSpecViewPositionAlignment.SetViewOffsets(iOffsetX : Real, iOffsetY : Real) : Boolean

Arguments

Name Input/Output Required? Type Comment
iOffsetX In Real

The horizontal offset.

iOffsetY In Real

The vertical offset.

ReturnType

Boolean

ASDStructuralView.IsAMasterElement()

ASDStructuralView-IsAMasterElement() can be used to verify if a given structural object is a primary element in the structural view.

Signature

ASDStructuralView.IsAMasterElement(StructureObject : Feature, oIsMaster : Boolean) : Boolean

Arguments

Name Input/Output Required? Type Comment
StructureObject In Feature

Structure Object. Only Product Occurrences are supported.

oIsMaster Out Boolean

Set to True if iStructureObject is primary, False otherwise.

ReturnType

Boolean

Example

Let Result(Boolean)
Let IsMaster(Boolean)
Let StructurePanel(ProductOccurrence)
Let DftView(DrwView)
Let ASDDftView(ASDView)
Let ASDDftStructuralView(ASDStructuralView)

// Retrieve the ASD structural view from a drawing or sheet or from an input argument
set DftView = ...
if( NULL < DftView)
  DftView-GetASDView(ASDDftView)
set ASDDftStructuralView = ASDDftView

// Retrieve the structure panel to test
set StructurePanel = ...

// Check if the structure panel is primary in the structural view
if( (StructurePanel < NULL) AND (ASDDftStructuralView < NULL))
  Result = ASDDftStructuralView.IsAMasterElement(StructurePanel, IsMaster) 

ASDView.GetViewBoxes()

ASDView-GetViewBoxes retrieves the view boxes from an ASDView.

Signature

ASDView.GetViewBoxes(oListViewBoxes : List) : Boolean

Arguments

Name Input/Output Required? Type Comment
oListViewBoxes Out List The list of ASDBox in the view.

ReturnType

Boolean

ASDView.GetASDAnnotation

ASDView-GetASDAnnotation retrieves all the associated annotations.

Signature

ASDView.GetASDAnnotation(oListASDAnnotation : List) : Boolean

Arguments

Name Input/Output Required Type Comment
oListASDAnnotation Out List The list of all ASD Annotation retrieved on view

Return Type

Boolean

ASDAnnotation.ListParameterNames

ASDAnnotation-ListParameterNames returns a list of parameter names. Using the name, value and type can then be retrieved.

Signature

ASDAnnotation.ListParameterNames(oListASDParameters : List) : Boolean

Arguments

Name Input/Output Required Type Comment
oListASDParameters Out List The list of parameters names defined in the annotation

ReturnType

Boolean

ASDAnnotation.ParameterType

ASDAnnotation-ParameterType lets you get the type of a parameter from its name. Depending on its type, the parameter value can be retrieved by the corresponding method.

Signature

ASDAnnotation.ParameterType(Name : String) : String

Arguments

Name Input/Output Required Type Comment
Parameter name In String Name of the parameter of string type

ReturnType

The possible values are as follows:

ASDAnnotation.GetParameterAngle

ASDAnnotation-GetParameterAngle lets you retrieve the parameter value of Angle type from its name.

Signature

ASDAnnotation.GetParameterAngle(Name : String) : Angle

Arguments

Name Input/Output Required Type Comment
Parameter name In String Name of the parameter of angle type

ReturnType

Angle

ASDAnnotation.GetParameterBoolean

ASDAnnotation-GetParameterBoolean lets you retrieve the parameter value of Boolean type from its name.

Signature

ASDAnnotation.GetParameterBoolean(Name : String) : Boolean

Arguments

Name Input/Output Required Type Comment
Parameter name In String Name of the parameter of Boolean type

ReturnType

Boolean

ASDAnnotation.GetParameterInteger

ASDAnnotation-GetParameterInteger lets you retrieve the parameter value of Integer type from its name.

Signature

ASDAnnotation.GetParameterInteger(Name : String) : Integer

Arguments

Name Input/Output Required Type Comment
Parameter name In String Name of the parameter of Integer type

ReturnType

Integer

ASDAnnotation.GetParameterLength

ASDAnnotation-GetParameterLength lets you retrieve the parameter value of Length type from its name.

Signature

ASDAnnotation.GetParameterLength(Name : String) : Length

Arguments

Name Input/Output Required Type Comment
Parameter name In String Name of the parameter of Length type

ReturnType

Length

ASDAnnotation.GetParameterReal

ASDAnnotation-GetParameterReal lets you retrieve the parameter value of Real type from its name.

Signature

ASDAnnotation.GetParameterReal(Name : String) : Real

Arguments

Name Input/Output Required Type Comment
Parameter name In String Name of the parameter of Real type

ReturnType

Real

ASDAnnotation.GetParameterString

ASDAnnotation-GetParameterString lets you retrieve the parameter value of String type from its name.

Signature

ASDAnnotation.GetParameterString(Name : String) : String

Arguments

Name Input/Output Required Type Comment
Parameter name In String Name of the parameter of String type

ReturnType

String

ASDAnnotation.HasParameter

ASDAnnotation-HasParameter verifies if the annotation contains a parameter of a given name.

Signature

ASDAnnotation.HasParameter(Name : String) : Boolean

Arguments

Name Input/Output Required Type Comment
Parameter name In String Name of the parameter

ReturnType

Boolean