DigiPara Liftdesigner LDX API
Loading...
Searching...
No Matches
Change sheet frame text background color

API method: ILDXSheetFrameText5.BackgroundColor

Treename: Sheets.LdvSheet1.LdvFrame3.Map.NOTE#DESC

 ' from Samples/Src/LDXAPIExamples/Example_LDXSheetFrameTexts.vb

   <APIHelpAttribute(APIHelpModes.FireCalcModel Or APIHelpModes.LoadLD3File, {APIHelpModes.InputParaLDXDoc}, "Sheets.LdvSheet1.LdvFrame3.Map.NOTE#DESC", "LDXSheetFrameText~BackgroundColor", "Change sheet frame text background color")>
   Public Shared Sub ChangeSheetFrameTextBackgroundColor(ByRef ldxDocument As DigiPara.LDX.LDXDocument)

     If ldxDocument.GetObject("Sheets.LdvSheet1.LdvFrame3.Map.") Is Nothing Then
         MsgBox("Desired sheet frame texts frame not found! Please reload the relevant .ld3 file.")
         Exit Sub
     End If

     With DirectCast(ldxDocument.GetLDXObject("Sheets.LdvSheet1.LdvFrame3.Map.").LDXType, DigiPara.LDX.LDXSheetFrameTexts)
         Dim text As DigiPara.LDX.LDXSheetFrameText = .Item(0)

         Select Case text.SheetFrameTextMode And DigiPara.LDX.SheetFrameTextModes.sftmBackgroundColorMask
            Case DigiPara.LDX.SheetFrameTextModes.sftmBackgroundColorByFrame, DigiPara.LDX.SheetFrameTextModes.sftmBackgroundColorNone
               ' turn background blue
               text.SheetFrameTextMode = text.SheetFrameTextMode And Not DigiPara.LDX.SheetFrameTextModes.sftmBackgroundColorMask Or DigiPara.LDX.SheetFrameTextModes.sftmBackgroundColorIndex
               text.BackgroundColor = 5
            Case DigiPara.LDX.SheetFrameTextModes.sftmBackgroundColorIndex
               ' use drawing background. This usually is not visible, unless the text overlaps with some drawing that is earlier in the drawing order. So pretty much useless.
               text.SheetFrameTextMode = text.SheetFrameTextMode And Not DigiPara.LDX.SheetFrameTextModes.sftmBackgroundColorMask Or DigiPara.LDX.SheetFrameTextModes.sftmBackgroundColorBackground
            Case Else
               ' back to no fill
               text.SheetFrameTextMode = text.SheetFrameTextMode And Not DigiPara.LDX.SheetFrameTextModes.sftmBackgroundColorMask Or DigiPara.LDX.SheetFrameTextModes.sftmBackgroundColorByFrame
         End Select
      End With

 End Sub