Skip to content

CheckBoxBindingArgs

This checkbox-specific argument carrier extends clsObjectBindingArgs with the extra decisions a checkbox binder needs when the source property is not a simple Boolean. It supplies the control reference, alternate checked and unchecked string values, and the valid-state color used when a checkbox binding needs non-default display behavior.

Purpose

  • Parameterize checkbox bindings that map a checked state to business-object string values such as Y and N.
  • Carry checkbox-specific display settings alongside the core binding metadata inherited from clsObjectBindingArgs.
  • Let registration code choose between default Boolean semantics and explicit string-backed semantics without changing binder construction.

Context

  • Namespace: SAIF.Presentation.Web.Binding
  • Assembly/package: SAIF.Presentation.Web.Binding.Infragistics103 (embedded/bundled as source, not independently packaged)

Public members

Member Signature Purpose
CheckBox Public Property CheckBox() As CheckBox Carries the checkbox control instance the binder should attach to.
CheckBoxBackColor Public Property CheckBoxBackColor() As Color Supplies the valid-state color that should be preserved for this checkbox binding.
TargetDataTypeIsString Public Property TargetDataTypeIsString() As Boolean Switches the binding between Boolean semantics and string-backed checked/unchecked semantics.
CheckedString Public Property CheckedString() As String Defines which source value represents the checked state.
UnCheckedString Public Property UnCheckedString() As String Defines which source value represents the unchecked state.
New Public Sub New() Creates an empty checkbox argument bag for later population.
New Public Sub New(ByVal inControl As Control, ByVal inBindObject As Object, ByVal inBindProperty As String, ByVal inBindType As BindTypes) Creates a checkbox argument bag from an existing control, source object, property, and bind direction.
New Public Sub New(ByVal inCheckBox As CheckBox, ByVal inBindObject As Object, ByVal inBindProperty As String, ByVal inCheckValue As String, ByVal inUnCheckValue As String, Optional ByVal inBindType As BindTypes = BindTypes.TwoWay) Creates a fully configured string-backed checkbox mapping for direct binder construction.
New Public Sub New(ByVal inCheckValue As String, ByVal inUnCheckValue As String) Creates a reusable checked/unchecked string mapping with the default valid-state color.
New Public Sub New(ByVal inCheckValue As String, ByVal inUnCheckValue As String, ByVal inBackColor As Color) Creates a reusable checked/unchecked string mapping plus a non-default valid-state color.
New Public Sub New(ByVal inBackColor As Color) Creates a Boolean checkbox configuration that only overrides the valid-state color.

Behavioral notes

  • Assigning CheckedString or UnCheckedString forces the target data type into string mode so the binder stops treating the source property as Boolean.
  • TargetDataTypeIsString provides a higher-level toggle for the same underlying mode switch used by the string-value constructors.

Constraints and usage notes

  • Use this type when the checkbox represents coded values rather than a Boolean property.
  • Because it inherits clsObjectBindingArgs, it can still carry the common source object, property, and bind-direction metadata expected by the manager.

Sources

  • SAIF.Presentation.Web.Binding.Infragistics103\clsObjectBindingArgs.vb