|
DigiPara Liftdesigner LDX API
|
API method: ILDXSheetFrameOverwrite5.Description
Treename: Shaft0.CW.BracketList.DBG
' from Samples/Src/LDXAPIExamples/Example_LDXSheetFrameOverwrites.vb
<APIHelpAttribute(APIHelpModes.FireCalcModel Or APIHelpModes.LoadLD3File, {APIHelpModes.InputParaLDXDoc}, "Shaft0.CW.BracketList.DBG", "LDXSheetFrameOverwrite~Description", "Change whole dimension text")>
Public Shared Sub ChangeDimensionText(ByRef ldxDocument As DigiPara.LDX.LDXDocument)
If ldxDocument.Sheets.ActiveSheet.ActiveSheetFrame.ViewType <> DigiPara.LDX.SheetFrameViewType.shfvtPlan Then
MsgBox("Please activate a PLAN view with a shaft depth dimension!")
Exit Sub
End If
Dim dimName As String = "Shaft0.CW.BracketList.DBG"
If ldxDocument.GetLDXObject(dimName) Is Nothing Then
MsgBox("Desired dimension not found! Please reload the relevant .ld3 file!")
Exit Sub
End If
Dim ldxSheetFrame As DigiPara.LDX.LDXSheetFrame = ldxDocument.Sheets.ActiveSheet.ActiveSheetFrame
Dim ldxSheetFrameOverwrites As DigiPara.LDX.LDXSheetFrameOverwrites = ldxSheetFrame.SheetFrameOverwrites
' For demonstration purposes only, we use Find() to check if an overwrite already exists.
' This is usually not different from just calling Add() straight away; however, Find() will find any
' suitable overwrite that matches the object, even those with asterisks in their pattern.
' Add() will only return an existing overwrite if there is one with exactly the matching pattern.
Dim ldxSheetFrameOverwrite As DigiPara.LDX.LDXSheetFrameOverwrite = ldxSheetFrameOverwrites.Find(dimName, DigiPara.LDX.SheetFrameOverwriteType.sfoDim)
If ldxSheetFrameOverwrite Is Nothing Then
ldxSheetFrameOverwrite = ldxSheetFrameOverwrites.Add(dimName, DigiPara.LDX.SheetFrameOverwriteType.sfoDim)
End If
' Dimension overwrite description is interpreted as sheet frame specific prefix. <!> supresses the real dimension value.
ldxSheetFrameOverwrite.Description = "<!>PREFIX REPLACE"
' note that the 400 is project units, you might divide this by the scale e.g. 20 to get paper units
If ldxDocument.Shafts(0).CWConsole.Comp.Wall = DigiPara.LDX.WallType.wtLeft Then
ldxSheetFrameOverwrite.Point.X = 400
ldxSheetFrameOverwrite.Point.Y = 0
ElseIf ldxDocument.Shafts(0).CWConsole.Comp.Wall = DigiPara.LDX.WallType.wtRight Then
ldxSheetFrameOverwrite.Point.X = -400
ldxSheetFrameOverwrite.Point.Y = 0
ElseIf ldxDocument.Shafts(0).CWConsole.Comp.Wall = DigiPara.LDX.WallType.wtRear Then
ldxSheetFrameOverwrite.Point.X = 0
ldxSheetFrameOverwrite.Point.Y = -400
End If
End Sub