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 objCompStrns As SolidEdgeFrameworkSupport.ComplexStrings2d
    Dim objCompStrn1 As SolidEdgeFrameworkSupport.ComplexString2d
    Dim objCompStrn2 As SolidEdgeFrameworkSupport.ComplexString2d
    Dim objL1 As SolidEdgeFrameworkSupport.Line2d
    Dim objL2 As SolidEdgeFrameworkSupport.Line2d
    Dim objL3 As SolidEdgeFrameworkSupport.Line2d
    Dim objL4 As SolidEdgeFrameworkSupport.Line2d
    Dim objBObjs1(0 To 1) As Object
    Dim objBObjs2(0 To 1) As Object
    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
    On Error GoTo 0
    'Get the Active Sheet object
    Set objSheet = objDoc.ActiveSheet
    'Create ComplexStrings2d collection object
    Set objCompStrns = objSheet.ComplexStrings2d
    'Draw few lines on the active sheet
    Set objL1 = objSheet.Lines2d.AddBy2Points(x1:=0.1, y1:=0.1, x2:=0.2, y2:=0.2)
    Set objL2 = objSheet.Lines2d.AddBy2Points(x1:=0.2, y1:=0.2, x2:=0.4, y2:=0.2)
    Set objL3 = objSheet.Lines2d.AddBy2Points(x1:=0.15, y1:=0.1, x2:=0.25, y2:=0.25)
    Set objL4 = objSheet.Lines2d.AddBy2Points(x1:=0.25, y1:=0.25, x2:=0.5, y2:=0.1)
    'Store the Objects in an Array
    Set objBObjs1(0) = objL1
    Set objBObjs1(1) = objL2
    Set objBObjs2(0) = objL3
    Set objBObjs2(1) = objL4
    'Create the ComplexString2d objects
    Set objCompStrn1 = objCompStrns.AddByObjects(ArraySize:=2, Members:=objBObjs1())
    Set objCompStrn2 = objCompStrns.AddByObjects(ArraySize:=2, Members:=objBObjs2())
    'Get the ZOrder of the first ComplexString2d
    lngZorder1 = objCompStrn1.ZOrder
    'Get the ZOrder of the second ComplexString2d
    lngZorder2 = objCompStrn2.ZOrder

    ' USER DISPLAY
    ' Release objects
    Set objApp = Nothing
    Set objDoc = Nothing
    Set objSheet = Nothing
    Set objCompStrns = Nothing
    Set objCompStrn1 = Nothing
    Set objCompStrn2 = Nothing
    Set objL1 = Nothing
    Set objL2 = Nothing
    Set objL3 = Nothing
    Set objL4 = Nothing
    Set objBObjs1(0) = Nothing
    Set objBObjs1(1) = Nothing
    Set objBObjs2(0) = Nothing
    Set objBObjs2(1) = Nothing
End Sub