Version

SmartWebControl Class Members

The following tables list the members exposed by SmartWebControl.

Protected Fields
 NameDescription
Protected FieldClientEventsIdID-value that must be used to create SmartClientSideEvent  
Protected FieldclientScriptRegisterKeyUsed to register the Javascript file.  
Protected FielddefaultJavaScriptFileNameDefault location and script filename for the main Javascript file supporting this SmartWebControl's client-side processing.  
Protected FieldDefaultJavaScriptFileNameCommonDefault location and script filename for the shared Javascript file providing base services to all client-side SmartWebControl elements.  
Protected FielddefaultStyleSheetFileNameDefault location and css filename for the style definitions used by default for this control  
Protected FieldIsAtlas  
Protected FieldjavaScriptFileThe javascript file name for the control.  
Protected FieldnoCssValue true means that no css should be rendered. It can be used when control is invisible or something like that. For example, DataProvider.  
Protected FieldnoScriptValue true means that no script should be rendered. It can be used when control does not have any script model. For example, DataProvider.  
Protected FieldrendererThe SmartRenderer responsible for providing rendering services.  
Protected FieldresourceJavaScriptName of embedded resource for main java script file Control is responsible for proper value of that variable, which should point to embedded location of file. Its value can be initialized in constructor of control.  
Protected FieldstyleInfoName  
Public Properties
 NameDescription
Public PropertyAccessKeyGets or sets the access key that allows you to quickly navigate to the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyAppRelativeTemplateSourceDirectoryGets or sets the application-relative virtual directory of the System.Web.UI.Page or System.Web.UI.UserControl object that contains this control. (Inherited from System.Web.UI.Control)
Public PropertyAttributesGets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyBackColorGets or sets the background color of the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyBorderColorGets or sets the border color of the Web control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyBorderStyleGets or sets the border style of the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyBorderWidthGets or sets the border width of the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyBrowserTargetType of browser the HTML should be created for. (Inherited from Infragistics.WebUI.WebControls.WebControlBase)
Public PropertyClientIDGets the control ID for HTML markup that is generated by ASP.NET. (Inherited from System.Web.UI.Control)
Public PropertyClientIDModeGets or sets the algorithm that is used to generate the value of the System.Web.UI.Control.ClientID property. (Inherited from System.Web.UI.Control)
Public PropertyControlsGets a System.Web.UI.ControlCollection object that represents the child controls for a specified server control in the UI hierarchy. (Inherited from System.Web.UI.Control)
Public PropertyControlStyleGets the style of the Web server control. This property is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyControlStyleCreatedGets a value indicating whether a System.Web.UI.WebControls.Style object has been created for the System.Web.UI.WebControls.WebControl.ControlStyle property. This property is primarily used by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyCssClassGets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyEnableAppStylingEnables support on this control for the Application Styling Framework(tm).  
Public PropertyEnabledGets or sets a value indicating whether the Web server control is enabled. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyEnableThemingGets or sets a value indicating whether themes apply to this control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyEnableViewStateGets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client. (Inherited from System.Web.UI.Control)
Public PropertyFontGets the font properties associated with the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyForeColorGets or sets the foreground color (typically the color of the text) of the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyHasAttributesGets a value indicating whether the control has attributes set. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyHeightGets or sets the height of the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyIDGets or sets the programmatic identifier assigned to the server control. (Inherited from System.Web.UI.Control)
Public PropertyImageDirectoryDirectory in which the images used for the tabs are stored. (Inherited from Infragistics.WebUI.WebControls.WebControlBase)
Public PropertyJavaScriptFileNameBase path and name for the Javascript file(s) used for client-side processing.  
Public PropertyJavaScriptFileNameCommonBase path and name for the common Javascript file providing client-side infrastructure.  
Public PropertyNamingContainerGets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same System.Web.UI.Control.ID property value. (Inherited from System.Web.UI.Control)
Public PropertyPageGets a reference to the System.Web.UI.Page instance that contains the server control. (Inherited from System.Web.UI.Control)
Public PropertyParentGets a reference to the server control's parent control in the page control hierarchy. (Inherited from System.Web.UI.Control)
Public PropertyRenderingCompatibilityGets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from System.Web.UI.Control)
Public PropertySiteGets information about the container that hosts the current control when rendered on a design surface. (Inherited from System.Web.UI.Control)
Public PropertySkinIDGets or sets the skin to apply to the control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyStyleGets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyStyleSetNameName of the Application Styling Framework(tm) style set defining the themed appearance for this control.  
Public PropertyStyleSetPathPath containing the Application Styling Framework(tm) style set files for this type of control.  
Public PropertyStyleSheetDirectory  
Public PropertyStyleSheetFileNameFile name and path to the CSS stylesheet for this SmartWebControl.  
Public PropertySupportsDisabledAttributeGets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to "disabled" when the control's System.Web.UI.WebControls.WebControl.IsEnabled property is false. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyTabIndexGets or sets the tab index of the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyTemplateControlGets or sets a reference to the template that contains this control. (Inherited from System.Web.UI.Control)
Public PropertyTemplateSourceDirectoryGets the virtual directory of the System.Web.UI.Page or System.Web.UI.UserControl that contains the current server control. (Inherited from System.Web.UI.Control)
Public PropertyToolTipGets or sets the text displayed when the mouse pointer hovers over the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyUniqueIDGets the unique, hierarchically qualified identifier for the server control. (Inherited from System.Web.UI.Control)
Public PropertyValidateRequestModeGets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. (Inherited from System.Web.UI.Control)
Public PropertyViewStateModeGets or sets the view-state mode of this control. (Inherited from System.Web.UI.Control)
Public PropertyVisibleGets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from System.Web.UI.Control)
Public PropertyWidthGets or sets the width of the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
Protected Properties
 NameDescription
Protected PropertyAdapterGets the browser-specific adapter for the control. (Inherited from System.Web.UI.Control)
Protected PropertyChildControlsCreatedGets a value that indicates whether the server control's child controls have been created. (Inherited from System.Web.UI.Control)
Protected PropertyClientIDSeparatorGets a character value representing the separator character used in the System.Web.UI.Control.ClientID property. (Inherited from System.Web.UI.Control)
Protected PropertyControlPrefixGets a short prefix qualifying this instance uniquely by it's control type.  
Protected PropertyEventsGets a list of event handler delegates for the control. This property is read-only. (Inherited from System.Web.UI.Control)
Protected PropertyHasChildViewStateGets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from System.Web.UI.Control)
Protected PropertyIdSeparatorGets the character used to separate control identifiers. (Inherited from System.Web.UI.Control)
Protected PropertyIsTrackingViewStateGets a value that indicates whether the server control is saving changes to its view state. (Inherited from System.Web.UI.Control)
Protected PropertyLoadViewStateByIDGets a value indicating whether the control participates in loading its view state by System.Web.UI.Control.ID instead of index. (Inherited from System.Web.UI.Control)
Protected PropertyPresetMaskResourcePath (Inherited from Infragistics.WebUI.WebControls.WebControlBase)
Protected PropertySubObjects  
Protected PropertyTagKeyGets the System.Web.UI.HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Protected PropertyTagNameGets the name of the control tag. This property is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Protected PropertyViewStateGets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page. (Inherited from System.Web.UI.Control)
Protected PropertyViewStateIgnoresCaseGets a value that indicates whether the System.Web.UI.StateBag object is case-insensitive. (Inherited from System.Web.UI.Control)
Public Methods
 NameDescription
Public MethodApplyStyleCopies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Public MethodApplyStyleSheetSkinApplies the style properties defined in the page style sheet to the control. (Inherited from System.Web.UI.Control)
Public MethodCopyBaseAttributesCopies the properties not encapsulated by the System.Web.UI.WebControls.WebControl.Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Public MethodDataBindOverloaded. Binds a data source to the invoked server control and all its child controls. (Inherited from System.Web.UI.Control)
Public MethodDisposeEnables a server control to perform final clean up before it is released from memory. (Inherited from System.Web.UI.Control)
Public MethodFindControlOverloaded. Searches the current naming container for a server control with the specified id parameter. (Inherited from System.Web.UI.Control)
Public MethodFocusSets input focus to a control. (Inherited from System.Web.UI.Control)
Public MethodGetRouteUrlOverloaded. Gets the URL that corresponds to a set of route parameters. (Inherited from System.Web.UI.Control)
Public MethodGetUniqueIDRelativeToReturns the prefixed portion of the System.Web.UI.Control.UniqueID property of the specified control. (Inherited from System.Web.UI.Control)
Public MethodHasControlsDetermines if the server control contains any child controls. (Inherited from System.Web.UI.Control)
Public MethodLoadPostDataProcesses data posted back from a web form.  
Public MethodLoadPresetOverloaded. Sets properties on the control that effect Appearance, Behavior, or Both, based on the information in the predefined Preset File. (Inherited from Infragistics.WebUI.WebControls.WebControlBase)
Public MethodMergeStyleCopies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Public MethodOnRaisePostDataChangedEventNotification furnished to subclasses when the RaisePostDataChangedEvent method is called. Virtual method called on  
Public MethodRaisePostBackEventProcesses events generated when a web form is posted back to the server.  
Public MethodRaisePostDataChangedEventCalled in response to the LoadPostData method indicating that the state of the element has changed.  
Public MethodRenderBeginTagRenders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Public MethodRenderControlOverloaded. Outputs server control content to a provided System.Web.UI.HtmlTextWriter object and stores tracing information about the control if tracing is enabled. (Inherited from System.Web.UI.Control)
Public MethodRenderEndTagRenders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Public MethodResetOverridden. Resets the SmartWebControl to its default state.  
Public MethodResolveClientUrlGets a URL that can be used by the browser. (Inherited from System.Web.UI.Control)
Public MethodResolveUrlConverts a URL into one that is usable on the requesting client. (Inherited from System.Web.UI.Control)
Public MethodSavePresetOverloaded. Saves the properties of a control to a file, so that they can be used by another control via the LoadPreset method. (Inherited from Infragistics.WebUI.WebControls.WebControlBase)
Public MethodSetRenderMethodDelegateAssigns an event handler delegate to render the server control and its content into its parent control. (Inherited from System.Web.UI.Control)
Public MethodSetValueOverloaded. Sets a property value into the ViewState based on an identifier specified in this or a derived class.  
Public MethodToStringReturns a string representation this object. (Inherited from Infragistics.WebUI.WebControls.WebControlBase)
Protected Methods
 NameDescription
Protected MethodAddAttributesToRenderAdds HTML attributes and styles that need to be rendered to the specified System.Web.UI.HtmlTextWriterTag. This method is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Protected MethodAddParsedSubObjectNotifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's System.Web.UI.ControlCollection object. (Inherited from System.Web.UI.Control)
Protected MethodBuildProfileTreeGathers information about the server control and delivers it to the System.Web.UI.Page.Trace property to be displayed when tracing is enabled for the page. (Inherited from System.Web.UI.Control)
Protected MethodClearCachedClientIDSets the cached System.Web.UI.Control.ClientID value to a null reference (Nothing in Visual Basic). (Inherited from System.Web.UI.Control)
Protected MethodClearChildControlStateDeletes the control-state information for the server control's child controls. (Inherited from System.Web.UI.Control)
Protected MethodClearChildStateDeletes the view-state and control-state information for all the server control's child controls. (Inherited from System.Web.UI.Control)
Protected MethodClearChildViewStateDeletes the view-state information for all the server control's child controls. (Inherited from System.Web.UI.Control)
Protected MethodClearEffectiveClientIDModeSets the System.Web.UI.Control.ClientIDMode property of the current control instance and of any child controls to System.Web.UI.ClientIDMode.Inherit. (Inherited from System.Web.UI.Control)
Protected MethodCreateControlCollectionCreates a new System.Web.UI.ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from System.Web.UI.Control)
Protected MethodCreateControlStyleCreates the style object that is used internally by the System.Web.UI.WebControls.WebControl class to implement all style related properties. This method is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Protected MethodCreateRendererInitializes a SmartRenderer associated with this element that assumes responsibility for creating a scene graph of user-interface elements and rendering (serializing) them to the end user.  
Protected MethodCreateSubObjectCreates subobjects of the appropriate type.  
Protected MethodDataBindChildrenBinds a data source to the server control's child controls. (Inherited from System.Web.UI.Control)
Protected MethodEnsureChildControlsDetermines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from System.Web.UI.Control)
Protected MethodEnsureIDCreates an identifier for controls that do not have an identifier assigned. (Inherited from System.Web.UI.Control)
Protected MethodEnsureRendererEnsures an associated SmartRenderer exists before rendering occurs.  
Protected MethodFindControlInPageFind child or descendant control in the Page object. (Inherited from Infragistics.WebUI.WebControls.WebControlBase)
Protected MethodGetDesignModeStateGets design-time data for a control. (Inherited from System.Web.UI.Control)
Protected MethodGetSubObjectObtains a subobject reference based on the specified id value. Subobjects are automatically managed for ViewState.  
Protected MethodHasEventsReturns a value indicating whether events are registered for the control or any child controls. (Inherited from System.Web.UI.Control)
Protected MethodInitializeStyleInitializes a Style property with default appearance based on an external CSS stylesheet.  
Protected MethodInitializeStyles  
Protected MethodIsLiteralContentDetermines if the server control holds only literal content. (Inherited from System.Web.UI.Control)
Protected MethodLoadViewStateOverridden. Rehydrates the SmartWebControl from a saved state object.  
Protected MethodOnBubbleEventDetermines whether the event for the server control is passed up the page's UI server control hierarchy. (Inherited from System.Web.UI.Control)
Protected MethodOnDataBindingRaises the System.Web.UI.Control.DataBinding event. (Inherited from System.Web.UI.Control)
Protected MethodOnInitOverridden. Fires the Init event after this SmartWebControl has been initialized with values from the .ASPX document, but before other elements on the Page have been initialized.  
Protected MethodOnLoadPostControlStateNotification furnished to subclasses when control state is processed from loaded post back data.  
Protected MethodOnLoadPostDataReceives notification when data has been posted back to a web form.  
Protected MethodOnLoadPostStateItemNotification furnished to subclasses to set properties on appropriate objects for values posted back from the client.  
Protected MethodOnPreRenderOverridden. Fires the PreRender event and registers blocks of content ahead of rendering.  
Protected MethodOnPropertyChangeOverloaded. Called in response to a change in the value of a property in ViewState based on an identifier specified in this or a derived class.  
Protected MethodOnRaisePostBackEventReceives notification when a web form posts back to the server with event information.  
Protected MethodRaiseBubbleEventAssigns any sources of the event and its information to the control's parent. (Inherited from System.Web.UI.Control)
Protected MethodRenderOverridden. Renders content from this SmartWebControl to the supplied HtmlTextWriter.  
Protected MethodResolveAdapterGets the control adapter responsible for rendering the specified control. (Inherited from System.Web.UI.Control)
Protected MethodSaveViewStateOverridden. Preserves a SmartWebControl into an object representing it's saved state to be restored later.  
Protected MethodSetDesignModeStateSets design-time data for a control. (Inherited from System.Web.UI.Control)
Protected MethodSetSubObjectEstablishes a subobject in the SubObjects hash collection.  
Protected MethodTrackViewStateOverridden. Indicates whether this SmartWebControl is tracking ViewState for its properties and subobjects.  
Public Events
 NameDescription
Public EventDataBindingOccurs when the server control binds to a data source. (Inherited from System.Web.UI.Control)
Public EventDisposedOccurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested. (Inherited from System.Web.UI.Control)
Public EventInitOccurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from System.Web.UI.Control)
Public EventLoadOccurs when the server control is loaded into the System.Web.UI.Page object. (Inherited from System.Web.UI.Control)
Public EventPreRenderOccurs after the System.Web.UI.Control object is loaded but prior to rendering. (Inherited from System.Web.UI.Control)
Public EventUnloadOccurs when the server control is unloaded from memory. (Inherited from System.Web.UI.Control)
See Also