Version

ObjectBase Class Members

The following tables list the members exposed by ObjectBase.

Protected Constructors
 NameDescription
Protected ConstructorObjectBase ConstructorOverloaded.   
Public Properties
 NameDescription
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.  
Protected Properties
 NameDescription
Protected PropertyAdditionalClientState  
Protected PropertyCollectionData  
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.  
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.  
Protected PropertyPropCountThis property is used to track the number of properties this object is sending to ClientState. Each derived class overrides this property to indicate the new total of properties. The number consists of the PropCount value of the base class plus the number of ClientState properties utilized by each derived class.  
Protected PropertyTransactionLists  
Protected PropertyViewStateProperty to return the ViewState bag for the object. If none exist, then one is created.  
Public Methods
 NameDescription
Public MethodCloneClones the object  
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.  
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.  
Protected MethodFlushEmpties the positional and occasional property stringBuffers and converts them to a string representation that can be written to the response stream.  
Protected MethodGetClientPropertiesArray  
Protected MethodLoadAdditionalClientStateThis method is called when additional information is passed from the client, via the _saveAdditionalClientState javascript method  
Protected MethodLoadClientCollectionsLoads the Collections that were sent down to the client, back into the control.  
Protected MethodLoadClientCollectionsTransactionListReads the TransactionList and repopulates the collections of the control.  
Protected MethodLoadClientObjectsLoads the Objects that were sent down to the client, back into the control.  
Protected MethodLoadClientObjectsTransactionListReads the Transaction List and repopulates the objects of the control.  
Protected MethodLoadClientProperties  
Protected MethodLoadClientPropsTransactionListReads the Transaction List and repopulates the properties of the control.  
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.  
Protected MethodLoadClientStateFromViewStateChecks to see if ClientState was saved into Viewstate, if so, then it loads.  
Protected MethodLoadCollectionsStateFromViewStateLoads the saved into view state client collections and deserializes the string as it came from the client side.  
Protected MethodLoadOccasionalProperties  
Protected MethodLoadOccasionalProperty  
Protected MethodLoadPositionalPropertiesLoads client state properties from the client  
Protected MethodLoadPositionalPropertyLoad positional property at index  
Protected MethodLoadTransactionListLoads the transaction list.  
Protected MethodLoadViewStateThis method loads the data contained in the state parameter into the ViewState bag for the object.  
Protected MethodOnPropertyChangeOverloaded. Virtual method that is called whenever a server state property within the object has been changed.  
Protected MethodPreFetchPositionalClientPropertyFetch a positional property from the transaction list before the properties are loaded.  
Protected MethodResetClientStateResets the positional and occasional property stringBuffers to initial empty values.  
Protected MethodSaveClientCollectionsSaves all Collections that should go to the client into a javascript array.  
Protected MethodSaveClientObjectsSaves all objects that should go to the client into a javascript array.  
Protected MethodSaveClientPropertiesOverloaded. Virtual method that serializes the ClientState properties of the object to a JSON stream that will be accessed from the client. The FullAddress property of the Object is also accessed in this process to identify the object being serialized to JSON.  
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.  
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.  
Protected MethodSaveViewStateThis method saves the property settings in the ViewState bag to the ViewState hidden field on the page for roundtripping between the server and client.  
Protected MethodTrackViewStateThis 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  
Protected MethodWriteClientCollections  
Protected MethodWriteClientObjects  
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.  
Protected MethodWriteClientProperties  
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.  
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.  
See Also