Version

StateBot Class Members

The following tables list the members exposed by StateBot.

Public Constructors
 NameDescription
Public ConstructorStateBot ConstructorOverloaded.   
Public Fields
 NameDescription
Public FieldCLIENTADDRESS  
Protected Fields
 NameDescription
Protected FieldcloseBracket  
Protected Fieldcomma  
Protected Fieldstatic (Shared in Visual Basic)jsDefaultDate  
Protected FieldopenBracket  
Protected Fieldquotecomma  
Protected Fieldquotes  
Public Properties
 NameDescription
Public PropertyAttributesAttributeCollection property that can be used to add Html markup attributes to the UIObject which will be rendered to the Html stream during the rendering phase. (Inherited from Infragistics.Web.UI.Framework.UIObject)
Public PropertyHasAttributesReturns a boolean value which indicates if the UIObject currently has any Attributes. (Inherited from Infragistics.Web.UI.Framework.UIObject)
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 PropertyTemplate (Inherited from Infragistics.Web.UI.Framework.UIObject)
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 PropertyFlagsStores all the ClientUIFlags into one integer, that will be passed down to the client in the Client Property Array. (Inherited from Infragistics.Web.UI.Framework.UIObject)
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.   
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 MethodCloneClones the object (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Public MethodEnsureTemplateOverloaded. This method takes a reference to a control and potentially, the children of the control, and adds them to the TemplateContainer for this UIObject, and thereby, to the control tree of the page. (Inherited from Infragistics.Web.UI.Framework.UIObject)
Public MethodFindControlThis method searches for a locates control objects within the TemplateContainer associated with this UIObject by using the Id parameter to match against control Ids. (Inherited from Infragistics.Web.UI.Framework.UIObject)
Public MethodIsDirtyOverloaded. Public shortcut to check if object has had data changes Derived classes must override this method if they conain subobjects in addition to Style or Attributes so that the item will be saved to ViewState if the subobject is dirty. (Inherited from Infragistics.Web.UI.Framework.UIObject)
Public Methodstatic (Shared in Visual Basic)RenderPropertyRenders an ObjectBase object into a string buffer containing the object JSON representation.  
Protected Methods
 NameDescription
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 MethodEnsureFlagTo be used in EnsureFlags. This method stores the ClientUIFlag in the private flags Hashtable. (Inherited from Infragistics.Web.UI.Framework.UIObject)
Protected MethodEnsureFlagsTo be overriden by base controls. This is where each control can set the default values for each ClientUIFlag that should be set. TO register a flag they should call EnsureFlag(ClientUIFlags, value). (Inherited from Infragistics.Web.UI.Framework.UIObject)
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 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 MethodLoadClientCollectionsOverridden.   
Protected MethodLoadClientCollectionsTransactionListReads the TransactionList and repopulates the collections of the control. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadClientObjectsOverridden.   
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 MethodLoadOccasionalPropertiesOverridden.   
Protected MethodLoadOccasionalProperty (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadPositionalPropertiesOverridden.   
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 MethodLoadViewStateThis method overrides the base LoadViewState implementation to add LoadViewState processing for the ControlStyle and Attributes collections. (Inherited from Infragistics.Web.UI.Framework.UIObject)
Protected MethodOnPropertyChangeOverloaded. Virtual method that is called whenever a server state property within the object has been changed. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
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 MethodSaveClientCollectionsOverridden.   
Protected MethodSaveClientObjectsOverridden.   
Protected MethodSaveClientPropertiesOverloaded. Overrides the SaveClientProperties method to add the UI Flags to the ClientState properties. (Inherited from Infragistics.Web.UI.Framework.UIObject)
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 MethodSaveViewStateThis method overrides the base SaveViewState implementation to add ViewState processing for the ControlStyle and Attributes collections. (Inherited from Infragistics.Web.UI.Framework.UIObject)
Protected MethodTrackViewStateThis method implements TrackViewState for the ControlStyle and Attributes subobjects of the UIObject. (Inherited from Infragistics.Web.UI.Framework.UIObject)
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)
See Also