Version

NavBot Class Members

The following tables list the members exposed by NavBot.

Public Constructors
 NameDescription
Public ConstructorNavBot ConstructorConstructs a NavBot object  
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 PropertyCustomAJAXResponseContainer for values passed to client within AJAX response. (Inherited from Infragistics.Web.UI.Framework.RunBot)
Public PropertyDesignMode (Inherited from Infragistics.Web.UI.Framework.RunBot)
Public PropertyEnableAjaxCallbacks (Inherited from Infragistics.Web.UI.Framework.RunBot)
Public PropertyEnableAppStylingEnables support on WebTree for the Application Styling Framework(tm). (Inherited from Infragistics.Web.UI.Framework.RunBot)
Public PropertyEnableEmbeddedJavaScriptInstructs the control to load its embedded Java Script. (Inherited from Infragistics.Web.UI.Framework.RunBot)
Public PropertyHasAttributesReturns a boolean value which indicates if the UIObject currently has any Attributes. (Inherited from Infragistics.Web.UI.Framework.UIObject)
Public PropertyImageDirectory (Inherited from Infragistics.Web.UI.Framework.RunBot)
Public PropertyIsCallback (Inherited from Infragistics.Web.UI.Framework.RunBot)
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 PropertyLoadViewStateCalledReturns whether the view state has been loaded yet (Inherited from Infragistics.Web.UI.Framework.RunBot)
Public PropertyStyleSetNameName of the Application Styling Framework(tm) style set defining the themed appearance for this control. (Inherited from Infragistics.Web.UI.Framework.RunBot)
Public PropertyStyleSetPathPath containing the Application Styling Framework(tm) style set files for this type of control. (Inherited from Infragistics.Web.UI.Framework.RunBot)
Public PropertyTemplate (Inherited from Infragistics.Web.UI.Framework.UIObject)
Public PropertyUserAgentInformation about client that is making the request. (Inherited from Infragistics.Web.UI.Framework.RunBot)
Public PropertyXAttributeIndicates which attribute should be used for XAttribute. (Inherited from Infragistics.Web.UI.Framework.RunBot)
Protected Properties
 NameDescription
Protected PropertyAdditionalClientState (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected PropertyCollectionData (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected PropertyControlReference to the control that owns this RunBot. (Inherited from Infragistics.Web.UI.Framework.RunBot)
Protected PropertyDeferLoadPostDataProcessingDetermines 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. (Inherited from Infragistics.Web.UI.Framework.RunBot)
Protected PropertyDelayLoadingClientCollectionsIf 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. (Inherited from Infragistics.Web.UI.Framework.RunBot)
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 PropertyIsClientStateDirtyGet whether the current client state is dirty. I.e. add/remove/insert happended on the client. Currently used only by WebDataTree.  
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 PropertyOptimizeCollectionsStateThe 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. (Inherited from Infragistics.Web.UI.Framework.RunBot)
Protected PropertyPropCountThe number of properties that should be sent down to the client. This value should come from the Object's Props Enumeration "Count"; (Inherited from Infragistics.Web.UI.Framework.RunBot)
Protected PropertySupportsAjaxIndicatorReturns true if control wants to support ajax indicator (Inherited from Infragistics.Web.UI.Framework.RunBot)
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 MethodAddXAttributeOverloaded. Write id to writer with one attribute. Before call to that method owner of this RunBot should call InitializeXAttributes() if not DesignMode. (Inherited from Infragistics.Web.UI.Framework.RunBot)
Public MethodAddXAttributeToClassNameOverloaded. Write class to writer with extra attribute. That method can be used only for the html element of main control which has normal id. (Inherited from Infragistics.Web.UI.Framework.RunBot)
Public MethodCalculateWidthHeightRequest to recalculate width and height of control. (Inherited from Infragistics.Web.UI.Framework.RunBot)
Public MethodCloneClones the object (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Public MethodCreateTemplateContainerControl (Inherited from Infragistics.Web.UI.Framework.RunBot)
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 MethodGetScriptReferences (Inherited from Infragistics.Web.UI.Framework.RunBot)
Public MethodGetValueOverloaded. Obtains a generic object property value from ViewState based on the string id defined as a constant in the derived class. (Inherited from Infragistics.Web.UI.Framework.RunBot)
Public MethodGetXAttributeStringReturns full XAttribute string which includes XAttribute name and its encoded value. (Inherited from Infragistics.Web.UI.Framework.RunBot)
Public MethodGetXAttributeValueReturns the value of XAttribute. (Inherited from Infragistics.Web.UI.Framework.RunBot)
Public MethodHandleLoadViewStateCalled when control view state is loaded. Here RunBot may load any additional data that was saved to the view state. (Inherited from Infragistics.Web.UI.Framework.RunBot)
Public MethodHandleOnInit (Inherited from Infragistics.Web.UI.Framework.RunBot)
Public MethodHandlePreRender (Inherited from Infragistics.Web.UI.Framework.RunBot)
Public MethodHandleRenderContents (Inherited from Infragistics.Web.UI.Framework.RunBot)
Public MethodHandleSaveViewStateCalled when control view state is saved. Here RunBot may save any additional data to the view state. (Inherited from Infragistics.Web.UI.Framework.RunBot)
Public MethodInitializeCollectionReferencesUsed by Control Developers only. Allows callers in external assemblies to initialize internal references for collections (Inherited from Infragistics.Web.UI.Framework.RunBot)
Public MethodInitializeStyles (Inherited from Infragistics.Web.UI.Framework.RunBot)
Public MethodInitializeXAttributesInitialize builder of XAttributes. That should be called for not DesignMode before every painting. (Inherited from Infragistics.Web.UI.Framework.RunBot)
Public MethodInstantiateTemplateOverloaded. Instantiates the template. (Inherited from Infragistics.Web.UI.Framework.RunBot)
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 MethodLoadClientDataThis method allows client data to be loaded at any time necessary and sets a flag so that it does not get loaded twice. (Inherited from Infragistics.Web.UI.Framework.RunBot)
Public MethodRegisterScriptDescriptorsRegisters script descriptors of the control the run bot is associated with. The method can be overriden to do custom descriptor registration. (Inherited from Infragistics.Web.UI.Framework.RunBot)
Public MethodSetValueOverloaded. Sets an object value so that it is maintained in viewstate (Inherited from Infragistics.Web.UI.Framework.RunBot)
Protected Methods
 NameDescription
Protected MethodApplyControlState (Inherited from Infragistics.Web.UI.Framework.RunBot)
Protected MethodAppStyleInfo (Inherited from Infragistics.Web.UI.Framework.RunBot)
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 MethodCreateStyleBot (Inherited from Infragistics.Web.UI.Framework.RunBot)
Protected MethodEnsureFlagTo be used in EnsureFlags. This method stores the ClientUIFlag in the private flags Hashtable. (Inherited from Infragistics.Web.UI.Framework.UIObject)
Protected MethodEnsureFlagsOverridden. A method internally used by the framework to determine which ClientUIFlags should be set on the object.  
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 MethodFormatCollectionEventOverloaded. Formats the collection event.  
Protected MethodGetClientPropertiesArray (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodGetScriptReference (Inherited from Infragistics.Web.UI.Framework.RunBot)
Protected MethodHasOtherCollectionDataSome runbots save their client objects, which are really collections in a member other than CollectionData, so they may want to load that in LoadClientCollections. (Inherited from Infragistics.Web.UI.Framework.RunBot)
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 MethodLoadClientCollectionsTransactionListOverridden. Loads the transaction list for a collection of objects and applies the updated values to each of the objects.  
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 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 MethodPreLoadAdditionalClientStateUse this if there is some additonal client state that should be loaded regardless of whether _deferLoadPostDataProcessing is true (Inherited from Infragistics.Web.UI.Framework.RunBot)
Protected MethodRaisePostDataChangedEvent (Inherited from Infragistics.Web.UI.Framework.RunBot)
Protected MethodRegisterIScriptControlScript (Inherited from Infragistics.Web.UI.Framework.RunBot)
Protected MethodRegisterScriptsRegisters js scripts for rendering and loading on the client. (Inherited from Infragistics.Web.UI.Framework.RunBot)
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. Saves basic control client properties like UniqueID, OptimizeCollectionsState, ViewStateEnabled, AjaxIndicator. Most of them are sent as client only properties. (Inherited from Infragistics.Web.UI.Framework.RunBot)
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 MethodTemplateInstantiatedThis is where a template container can be modified. The template is already instantiated and the controls are created. (Inherited from Infragistics.Web.UI.Framework.RunBot)
Protected MethodTrackViewStateThis method implements TrackViewState for the ControlStyle and Attributes subobjects of the UIObject. (Inherited from Infragistics.Web.UI.Framework.UIObject)
Protected MethodWriteAdditionalClientProperties (Inherited from Infragistics.Web.UI.Framework.RunBot)
Protected MethodWriteClientCollections (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodWriteClientEvents (Inherited from Infragistics.Web.UI.Framework.RunBot)
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