Boolean Properties in XPO

• May 26, 2023
• 2 minutes to read

The example below illustrates how to implement Boolean Properties in an XPO persistent class.

C#

// By default, a Boolean property is displayed via a CheckEdit control.
public bool BooleanProperty {
    get { return booleanProperty; }
    set { SetPropertyValue(nameof(BooleanProperty), ref booleanProperty, value); }
}
// To use a drop-down control, specify captions with the CaptionsForBoolValues attribute.
private bool booleanWithCaptions;
[CaptionsForBoolValues("TRUE", "FALSE")]
public bool BooleanWithCaptions {
    get { return booleanWithCaptions; }
    set { SetPropertyValue(nameof(BooleanWithCaptions), ref booleanWithCaptions, value); }
}
// To display images in a drop-down, apply the ImagesForBoolValues attribute.
private bool booleanWithImages;
[ImagesForBoolValues("ImageForTrue", "ImageForFalse")]
[CaptionsForBoolValues("TRUE", "FALSE")]
public bool BooleanWithImages {
    get { return booleanWithImages; }
    set { SetPropertyValue(nameof(BooleanWithImages), ref booleanWithImages, value); }
}

VB.NET

' By default, a Boolean property is displayed via a CheckEdit control.
Public Property BooleanProperty() As Boolean
    Get
        Return booleanProperty
    End Get
    Set(ByVal value As Boolean)
        SetPropertyValue(NameOf(BooleanProperty), booleanProperty, value)
    End Set
End Property
' To use a drop-down control, specify captions with the CaptionsForBoolValues attribute.
Private _booleanWithCaptions As Boolean
<CaptionsForBoolValues("TRUE", "FALSE")>
Public Property BooleanWithCaptions() As Boolean
    Get
        Return _booleanWithCaptions
    End Get
    Set(ByVal value As Boolean)
        SetPropertyValue(NameOf(BooleanWithCaptions), _booleanWithCaptions, value)
    End Set
End Property
' To display images in a drop-down, apply the ImagesForBoolValues attribute.
Private _booleanWithImages As Boolean
<ImagesForBoolValues("ImageForTrue", "ImageForFalse"), _
CaptionsForBoolValues("TRUE", "FALSE")>
Public Property BooleanWithImages() As Boolean
    Get
        Return _booleanWithImages
    End Get
    Set(ByVal value As Boolean)
        SetPropertyValue(NameOf(BooleanWithImages), _booleanWithImages, value)
    End Set
End Property

You can also specify captions and images via the following properties in the Model Editor:

• IModelCommonMemberViewItem.CaptionForTrue
• IModelCommonMemberViewItem.CaptionForFalse
• IModelCommonMemberViewItem.ImageForTrue
• IModelCommonMemberViewItem.ImageForFalse