ZOrder Property

Description

Specifies the front-to-back order in which an object is displayed relative to other objects.

Property type

Read-only property

Syntax

Visual Basic
Public Property ZOrder As Long

Remarks

This relationship is maintained by storing a cardinal order position on each object. An object with a higher cardinal order is displayed in front of one with a lower cardinal number. A change in an object's ZOrder changes how objects are displayed if filled objects are displayed over other objects. The value assigned to this property can be changed internally to maintain unique values on all objects. Therefore, the value returned for this property may not be the same value to which the property was set.

Example

Example (Visual Basic)

Private Sub Form_Load()
    Dim objApp As SolidEdgeFrameWork.Application
    Dim objDoc As SolidEdgeDraft.DraftDocument
    Dim objSheet As SolidEdgeDraft.Sheet
    Dim objCenterLines As SolidEdgeFrameworkSupport.CenterLines
    Dim objCenterLine As SolidEdgeFrameworkSupport.CenterLine
    Dim objLine As SolidEdgeFrameworkSupport.Line2d
    Dim lngZOrder1 As Long
    Dim lngZOrder2 As Long

    ' Report errors
    Const PI = 3.14159265358979
    ' Create/get the application with specific settings
    On Error Resume Next
    Set objApp = GetObject(, "SolidEdge.Application")
    If Err Then
        Err.Clear
        Set objApp = CreateObject("SolidEdge.Application")
        Set objDoc = objApp.Documents.Add("SolidEdge.DraftDocument")
        objApp.Visible = True
    Else
        Set objDoc = objApp.ActiveDocument
    End If
    'getting the Active Sheet object
    Set objSheet = objDoc.ActiveSheet
    ' Get the CenterLines object on the active sheet
    Set objCenterLines = objSheet.CenterLines

    ' Draw a CenterLine on the active sheet
    Set objCenterLine = objCenterLines.Add(x1:=0.25, y1:=0.15, z1:=0, _
                                           x2:=0.25, y2:=0.35, z2:=0)
    ' Get the ZOrder Property
    lngZOrder2 = objCenterLine.ZOrder
    ' Create a Line object
    Set objLine = objSheet.Lines2d.AddBy2Points(x1:=0.2, y1:=0.1, x2:=0.25, y2:=0.3)
    ' Get the ZOrder of Line object
    lngZOrder1 = objLine.ZOrder

    ' USER DISPLAY
    ' Release objects
    Set objApp = Nothing
    Set objDoc = Nothing
    Set objSheet = Nothing
    Set objCenterLines = Nothing
    Set objCenterLine = Nothing
    Set objLine = Nothing
End Sub