Version

UnboundCheckBoxField Class Members

The following tables list the members exposed by UnboundCheckBoxField.

Public Constructors
 NameDescription
Public ConstructorUnboundCheckBoxField ConstructorOverloaded.   
Public Properties
 NameDescription
Public PropertyCellTextSpecifies the text to display next to the checkbox.  
Public PropertyCheckBoxThe object for customizing the checkboxes displayed in the column  
Public PropertyCssClassGets/sets the css class name that will be set to the grid field. (Inherited from Infragistics.Web.UI.GridControls.GridField)
Public PropertyFooterGets the GridFieldCaption object that contains the footer information. (Inherited from Infragistics.Web.UI.GridControls.GridField)
Public PropertyFormatFieldMethodIf assigned formats the values of the field. (Inherited from Infragistics.Web.UI.GridControls.ControlDataField)
Public PropertyHasFooterReturns true if there is a FooterCaption object (Inherited from Infragistics.Web.UI.GridControls.GridField)
Public PropertyHasHeaderReturns true if there is a header caption object. (Inherited from Infragistics.Web.UI.GridControls.GridField)
Public PropertyHeaderGets the GridFieldCaption object that is assigned to the header. (Inherited from Infragistics.Web.UI.GridControls.GridField)
Public PropertyHeaderCheckBoxModeThe mode of the checkbox in the header.  
Public PropertyHeaderCheckBoxStateReturns the state of the header checkbox, if there is one.  
Public PropertyHeaderCheckedGets/sets the checked value of the header checkbox  
Public PropertyHiddenMakes the field to be rendered hidden to the browser. The field's visibility can be triggered from both server and client side. (Inherited from Infragistics.Web.UI.GridControls.ControlDataField)
Public PropertyIndexIndeax of the field inside of its parent collection. (Inherited from Infragistics.Web.UI.GridControls.ControlDataField)
Public PropertyIsEmptyChecks if ViewState has any property with not a default value. This property should be overriden by extended class when additional subobjects are supported. IsEmpty will then check each subobject and return a value based on the check of those objects plus itself. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Public PropertyIsNullableReturns whether the data for this column is nullable (Inherited from Infragistics.Web.UI.GridControls.ControlDataField)
Public PropertyKeyKey that identifies the field. (Inherited from Infragistics.Web.UI.GridControls.GridField)
Public PropertyOwnerCollectionReference back to the owner collection of the field. (Inherited from Infragistics.Web.UI.GridControls.ControlDataField)
Public PropertyToolTipCheckedThe tooltip and alt tag used for a cell checkbox when it is checked. {0} is replaced by the cell's value.  
Public PropertyToolTipPartialThe tooltip and alt tag used for a cell checkbox when it is partially checked. {0} is replaced by the cell's value.  
Public PropertyToolTipUncheckedThe tooltip and alt tag used for a cell checkbox when it is unchecked. {0} is replaced by the cell's value.  
Public PropertyTypeOverridden. Type of the items in the field. If not set explicitly returns the data source's field type.  
Public PropertyVisibleIndexVisible index of field. When setting visible index it acts like an insert and it modifies all other indexes. VisibleIndex should be set starting from 0, then 1, etc. It is recommended this property to be set after the fields have been created. (Inherited from Infragistics.Web.UI.GridControls.GridField)
Public PropertyWidthGets/sets the width of the GridField. (Inherited from Infragistics.Web.UI.GridControls.GridField)
Protected Properties
 NameDescription
Protected PropertyAdditionalClientState (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected PropertyCollectionData (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected PropertyDelayLoadingClientCollectionsCustomizes the client collections loading. If true the collections will be loaded after view state has been loaded. If false the collections will be loaded in RunBot.HandleOnInit. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected PropertyEventsAn EventHandlerList holding events for this field (Inherited from Infragistics.Web.UI.GridControls.ControlDataField)
Protected PropertyGridReturns the Grid that owns this field (Inherited from Infragistics.Web.UI.GridControls.GridField)
Protected PropertyIsTrackingViewStateThis method returns a boolean value which indicates whether ViewState is being tracked for the object. Once viewstate is being tracked, all property changes are roundtripped from server to client and back within the ViewState hidden field. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected PropertyPropCountOverridden. Returns number of properties for the client state supported by the UnboundCheckBoxField.  
Protected PropertyTransactionLists (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected PropertyViewStateProperty to return the ViewState bag for the object. If none exist, then one is created. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Public Methods
 NameDescription
Public MethodCalculateStateTakes in a value, such as from a GridRecordItem, and coverts it to a CheckBoxState  
Public MethodCloneCreates a clone of this object (Inherited from Infragistics.Web.UI.GridControls.ControlDataField)
Public MethodCopyPropertiesToOverridden. Copies the properties of this UnboundCheckBoxField to the given field  
Public MethodFormatValueFormats the given value according to the fields DataFormatString (Inherited from Infragistics.Web.UI.GridControls.UnboundField)
Public MethodIsDirtyOverloaded. This method determines if the property with the specified Id within the ViewState bag is dirty and needs to be sent to and from the client. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Public MethodToStringString representation of the field. (Inherited from Infragistics.Web.UI.GridControls.ControlDataField)
Protected Methods
 NameDescription
Protected MethodCreateFooterCaptionThis creates a new GridFieldCaption as the footer for this field (Inherited from Infragistics.Web.UI.GridControls.GridField)
Protected MethodCreateHeaderCaptionThis creates a new GridFieldCaption as the header for this field (Inherited from Infragistics.Web.UI.GridControls.GridField)
Protected MethodCreateNewInstanceCreates a new instance of the current type using the default constructor. Derived classes may override the method if there is no parameterless constructor or any other custom logic applies. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodFlushEmpties the positional and occasional property stringBuffers and converts them to a string representation that can be written to the response stream. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodGenerateAttributesEnsures that certain attributes are rendered on the GridField (Inherited from Infragistics.Web.UI.GridControls.GridField)
Protected MethodGetClientPropertiesArray (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadAdditionalClientStateThis method is called when additional information is passed from the client, via the _saveAdditionalClientState javascript method (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadClientCollectionsLoads the Collections that were sent down to the client, back into the control. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadClientCollectionsTransactionListReads the TransactionList and repopulates the collections of the control. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadClientObjectsLoads the Objects that were sent down to the client, back into the control. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadClientObjectsTransactionListReads the Transaction List and repopulates the objects of the control. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadClientProperties (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadClientPropsTransactionListReads the Transaction List and repopulates the properties of the control. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadClientStateThis method takes the state from the client and loads the control's Properties, Objects, and Collections, that were sent down to the client on the last post. It also stores the TransactionLists for the Properties, Objects, and Collections. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadClientStateFromViewStateChecks to see if ClientState was saved into Viewstate, if so, then it loads. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadCollectionsStateFromViewStateLoads the saved into view state client collections and deserializes the string as it came from the client side. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadOccasionalProperties (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadOccasionalProperty (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadPositionalPropertiesLoads client state properties from the client (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadPositionalPropertyLoad positional property at index (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadTransactionListLoads the transaction list. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadViewStateOverridden. Load data modified at run time.  
Protected MethodOnAddedToCollectionIs called when an object is added to collection. This was refactored a bit so that the objects which inherite from this class can overwrite this method and their own logic. (Inherited from Infragistics.Web.UI.GridControls.GridField)
Protected MethodOnKeyChangedFires the key changed event (Inherited from Infragistics.Web.UI.GridControls.ControlDataField)
Protected MethodOnPropertyChangeOverloaded. Overridden. Event fired when a property changes on this field  
Protected MethodPreFetchPositionalClientPropertyFetch a positional property from the transaction list before the properties are loaded. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodResetClientStateResets the positional and occasional property stringBuffers to initial empty values. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodSaveClientCollectionsSaves all Collections that should go to the client into a javascript array. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodSaveClientObjectsSaves all objects that should go to the client into a javascript array. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodSaveClientPropertiesOverloaded. Overridden. Saves any additional properties to be brought to the client.  
Protected MethodSaveClientStateToViewStateIf the control is not visible, we don't want to loose our ClientState during the next postback, so lets store it in ViewState. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodSaveCollectionsStateToViewStateSaves the client collections state as string into the view state. This way we can skip the expensive serialization on the client side and not send them at all. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodSaveViewStateOverridden. Save data modified at run time.  
Protected MethodShouldSerializeFooterDetermines if Footer property should be serialized. (Inherited from Infragistics.Web.UI.GridControls.GridField)
Protected MethodShouldSerializeHeaderDetermines if Header property should be serialized. (Inherited from Infragistics.Web.UI.GridControls.GridField)
Protected MethodShouldSerializeWidthReturns bool indicating if the Width is empty (Inherited from Infragistics.Web.UI.GridControls.GridField)
Protected MethodTrackViewStateOverridden. This method turns on ViewState tracking for the object  
Protected MethodWriteAdditionalClientPropertiesIf an object needs to render additional information that needs to be accessed on the client, this is where they can add this information. Note that each object that they need to render should be prefixed with a Comma because the information is being rendered inside of a javascript array. This method is called by WriteClientProperties (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodWriteClientCollections (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodWriteClientObjects (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodWriteClientOnlyPropertyStores the property in hashtable, that will be rendered down to the client. Client only properties only get sent down to the client, they do not get sent back to the server. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodWriteClientProperties (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodWriteClientStateResponsible for rendering javascript array of all client properties, events, objects and collections Calls helper methods to render each in turn. That method is called to render parameter for initialization (constructor) java-script function. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodWritePositionalPropertyWrites the passed in property value at the current position of the ClientState serialization. The property is serialized to the positional properties string of the ClientState string. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Public Events
 NameDescription
Public EventKeyChangedThe KeyChanged event is raised when the field's Key property has been changed. (Inherited from Infragistics.Web.UI.GridControls.ControlDataField)
See Also