RunBot Class Members

The following tables list the members exposed by RunBot.

Public Constructors

	Name	Description
	RunBot Constructor	Creates a RunBot derived object and stores a reference to the ControlMain object that is associated.

Public Properties

	Name	Description
	Attributes	AttributeCollection 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)
	CustomAJAXResponse	Container for values passed to client within AJAX response.
	DesignMode
	EnableAjaxCallbacks
	EnableAppStyling	Enables support on WebTree for the Application Styling Framework(tm).
	EnableEmbeddedJavaScript	Instructs the control to load its embedded Java Script.
	HasAttributes	Returns a boolean value which indicates if the UIObject currently has any Attributes. (Inherited from Infragistics.Web.UI.Framework.UIObject)
	ImageDirectory
	IsCallback
	IsEmpty	Checks 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)
	LoadViewStateCalled	Returns whether the view state has been loaded yet
	StyleSetName	Name of the Application Styling Framework(tm) style set defining the themed appearance for this control.
	StyleSetPath	Path containing the Application Styling Framework(tm) style set files for this type of control.
	Template	(Inherited from Infragistics.Web.UI.Framework.UIObject)
	UserAgent	Information about client that is making the request.
	XAttribute	Indicates which attribute should be used for XAttribute.

Protected Properties

	Name	Description
	AdditionalClientState	(Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	CollectionData	(Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	Control	Reference to the control that owns this RunBot.
	DeferLoadPostDataProcessing	Determines if the loading of postback data should be deferred until a later point when the object model is properly restored. This situaion occurs when no ViewState is present and the control must databind first in order to populate the object model.
	DelayLoadingClientCollections	Overridden. If true will delay the client collections loading in LoadPostData, after the view state has been loaded. If false the client collections will be loaded in HandleOnInit, when LoadClientState is called.
	Flags	Stores 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)
	IsTrackingViewState	This 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)
	OptimizeCollectionsState	The collections client state will be stored in the view state and the client collections will not be sent from the client on postback. This is possible because client collections contain static data that does not change on the client. This data is used by the client API and when something is updated it is stored in the transactions list. If false the collections from the client side will be uploaded as before. Setting this to true, will increase page size in terms of view state, but will decrease the postback time numerously, because the collections state will not be uploaded from the client.
	PropCount	Overridden. The number of properties that should be sent down to the client. This value should come from the Object's Props Enumeration "Count";
	SupportsAjaxIndicator	Returns true if control wants to support ajax indicator
	TransactionLists	(Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	ViewState	Property to return the ViewState bag for the object. If none exist, then one is created. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)

Public Methods

	Name	Description
	AddXAttribute	Overloaded. Write id to writer with one attribute. Before call to that method owner of this RunBot should call InitializeXAttributes() if not DesignMode.
	AddXAttributeToClassName	Overloaded. Write class to writer with extra attribute. That method can be used only for the html element of main control which has normal id.
	CalculateWidthHeight	Request to recalculate width and height of control.
	Clone	Clones the object (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	CreateTemplateContainerControl
	EnsureTemplate	Overloaded. 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)
	FindControl	This 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)
	GetScriptReferences
	GetValue	Overloaded. Obtains a generic object property value from ViewState based on the string id defined as a constant in the derived class.
	GetXAttributeString	Returns full XAttribute string which includes XAttribute name and its encoded value.
	GetXAttributeValue	Returns the value of XAttribute.
	HandleLoadViewState	Called when control view state is loaded. Here RunBot may load any additional data that was saved to the view state.
	HandleOnInit
	HandlePreRender
	HandleRenderContents
	HandleSaveViewState	Called when control view state is saved. Here RunBot may save any additional data to the view state.
	InitializeCollectionReferences	Used by Control Developers only. Allows callers in external assemblies to initialize internal references for collections
	InitializeStyles
	InitializeXAttributes	Initialize builder of XAttributes. That should be called for not DesignMode before every painting.
	InstantiateTemplate	Overloaded. Instantiates the template.
	IsDirty	Overloaded. 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)
	LoadClientData	This method allows client data to be loaded at any time necessary and sets a flag so that it does not get loaded twice.
	RegisterScriptDescriptors	Registers script descriptors of the control the run bot is associated with. The method can be overriden to do custom descriptor registration.
	SetValue	Overloaded. Sets an object value so that it is maintained in viewstate

Protected Methods

	Name	Description
	ApplyControlState
	AppStyleInfo
	CreateNewInstance	Creates 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)
	CreateStyleBot
	EnsureFlag	To be used in EnsureFlags. This method stores the ClientUIFlag in the private flags Hashtable. (Inherited from Infragistics.Web.UI.Framework.UIObject)
	EnsureFlags	Overridden.
	Flush	Empties 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)
	GetClientPropertiesArray	(Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	GetScriptReference
	HasOtherCollectionData	Some runbots save their client objects, which are really collections in a member other than CollectionData, so they may want to load that in LoadClientCollections.
	LoadAdditionalClientState	This method is called when additional information is passed from the client, via the _saveAdditionalClientState javascript method (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	LoadClientCollections	Loads the Collections that were sent down to the client, back into the control. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	LoadClientCollectionsTransactionList	Reads the TransactionList and repopulates the collections of the control. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	LoadClientObjects	Loads the Objects that were sent down to the client, back into the control. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	LoadClientObjectsTransactionList	Reads the Transaction List and repopulates the objects of the control. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	LoadClientProperties	(Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	LoadClientPropsTransactionList	Reads the Transaction List and repopulates the properties of the control. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	LoadClientState	This 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)
	LoadClientStateFromViewState	Checks to see if ClientState was saved into Viewstate, if so, then it loads. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	LoadCollectionsStateFromViewState	Loads 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)
	LoadOccasionalProperties	(Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	LoadOccasionalProperty	(Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	LoadPositionalProperties	Loads client state properties from the client (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	LoadPositionalProperty	Load positional property at index (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	LoadTransactionList	Loads the transaction list. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	LoadViewState	This method overrides the base LoadViewState implementation to add LoadViewState processing for the ControlStyle and Attributes collections. (Inherited from Infragistics.Web.UI.Framework.UIObject)
	OnPropertyChange	Overloaded. Virtual method that is called whenever a server state property within the object has been changed. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	PreFetchPositionalClientProperty	Fetch a positional property from the transaction list before the properties are loaded. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	PreLoadAdditionalClientState	Use this if there is some additonal client state that should be loaded regardless of whether _deferLoadPostDataProcessing is true
	RaisePostDataChangedEvent
	RegisterIScriptControlScript
	RegisterScripts	Registers js scripts for rendering and loading on the client.
	ResetClientState	Resets the positional and occasional property stringBuffers to initial empty values. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	SaveClientCollections	Saves all Collections that should go to the client into a javascript array. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	SaveClientObjects	Saves all objects that should go to the client into a javascript array. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	SaveClientProperties	Overloaded. Overridden. Saves basic control client properties like UniqueID, OptimizeCollectionsState, ViewStateEnabled, AjaxIndicator. Most of them are sent as client only properties.
	SaveClientStateToViewState	If 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)
	SaveCollectionsStateToViewState	Saves 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)
	SaveViewState	This method overrides the base SaveViewState implementation to add ViewState processing for the ControlStyle and Attributes collections. (Inherited from Infragistics.Web.UI.Framework.UIObject)
	TemplateInstantiated	This is where a template container can be modified. The template is already instantiated and the controls are created.
	TrackViewState	This method implements TrackViewState for the ControlStyle and Attributes subobjects of the UIObject. (Inherited from Infragistics.Web.UI.Framework.UIObject)
	WriteAdditionalClientProperties	Overridden.
	WriteClientCollections	(Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	WriteClientEvents
	WriteClientObjects	(Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	WriteClientOnlyProperty	Stores 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)
	WriteClientProperties	(Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	WriteClientState	Responsible 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)
	WritePositionalProperty	Writes 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)

Reference

RunBot Class
Infragistics.Web.UI.Framework Namespace

ASP.NET | Help Topics

RunBot Class Members

Reference