2.42.23 UserDefLabel

Description

Get and Set the sheet Row Label for a User-Defined Label row.

Syntax

VB: Property Get/Let UserDefLabel([ indexInType As ByVal Object ] ) As String

C++: LPCSTR UserDefLabel(_variant_t indexInType )

C#: string UserDefLabel(var indexInType )

Parameters

indexInType

0 offset index to a user-defined label row.

Remark

Examples

VB

    Sub UserDefLabel()
        Dim app As Origin.IOApplication
        Dim wks As Origin.Worksheet

        app = New Origin.ApplicationSI
        wks = app.FindWorksheet("") 'get active worksheet
        If wks Is Nothing Then
            MsgBox("Can not get active worksheet!")
            Exit Sub
        End If
        wks.LabelVisible(Origin.LABELTYPEVALS.LT_USER_DEF_LABEL) = True 'make user-defined label visible
        wks.UserDefLabel = "UserHeader" 'set as header name and can check it in Origin

    End Sub

LabVIEW

The following LabVIEW Block Diagram shows how to set a worksheet's user-defined parameter name as "Device ID".

Version Information

8.0SR2

See Also

Column.UserDefLabel