Back to Devexpress

ASPxHint Members

aspnet-devexpress-dot-web-dot-aspxhint-dot-underscore-members.md

latest62.6 KB
Original Source

ASPxHint Members

A hint control.

Constructors

NameDescription
ASPxHint()Initializes a new instance of the ASPxHint class with default settings.
ASPxHint(ASPxWebControl)Initializes a new instance of the ASPxHint class with specified settings.

Properties

NameDescription
Adapter protectedGets the browser-specific adapter for the control. Inherited from Control.
AllowFlipGets or sets a value that specifies whether to flip the hint to the opposite position relative to the target element.
AllowShiftGets or sets a value that specifies whether to shift a hint if its content and title are hidden outside of the client area.
AnimationGets or sets whether a hint should use animation effects when it appears.
AppearAfterGets or sets the delay in displaying the hint.
AppRelativeTemplateSourceDirectoryGets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. Inherited from Control.
AttributesGets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. Inherited from WebControl.
BackwardCompatibility staticProvides access to the control’s backward compatibility settings. Inherited from ASPxWebControl.
ChildControlsCreated protectedGets a value that indicates whether the server control’s child controls have been created. Inherited from Control.
ClientIDGets the control’s identifier generated by ASP.NET. Inherited from ASPxWebControlBase.
ClientIDSeparator protectedGets a character value representing the separator character used in the ClientID property. Inherited from Control.
ClientInstanceNameGets or sets the ASPxHint‘s client programmatic identifier.
ClientSideEventsGets an object that lists the client-side events specific to the ASPxHint.
ContentGets or sets the hint’s content.
ContentAttributeGets or sets the attribute name.
Context protectedGets the HttpContext object associated with the server control for the current Web request. Inherited from Control.
ControlsGets the web control’s collection of child controls. Inherited from ASPxWebControlBase.
ControlStyleGets the style of the Web server control. This property is used primarily by control developers. Inherited from WebControl.
ControlStyleCreatedGets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers. Inherited from WebControl.
CssClassGets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. Inherited from WebControl.
CssFilePathGets or sets the path to a CSS file that defines the web control’s appearance. Inherited from ASPxWebControl.
CssPostfixGets or sets a CSS class name postfix that identifies style settings to be applied to the control. Inherited from ASPxWebControl.
DataItemContainerGets a reference to the naming container if the naming container implements IDataItemContainer. Inherited from Control.
DataKeysContainerGets a reference to the naming container if the naming container implements IDataKeysControl. Inherited from Control.
DisabledCssClass staticGets or sets the CSS class to apply to the rendered HTML element when the control is disabled. Inherited from WebControl.
DisappearAfterGets or sets the duration after which a hint disappears when the mouse pointer is no longer positioned over the target element.
EmptyImage staticObsolete. Gets the settings of an image which is displayed by the control if the control’s value is null. Inherited from ASPxWebControl.
EnabledGets or sets a value that indicates whether a web control is enabled, allowing it to respond to user interactions. Inherited from ASPxWebControl.
EnableDefaultAppearanceObsolete. Specifies whether to enable the control’s default appearance. Inherited from ASPxWebControl.
EnableThemingGets or sets a value indicating whether themes apply to this control. Inherited from WebControl.
EnableViewStateGets 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 Control.
EncodeHtmlGets or sets whether to encode editor value and content. Inherited from ASPxWebControl.
Events protectedGets a list of event handler delegates for the control. This property is read-only. Inherited from Control.
GlobalAccessibilityCompliant staticGets or sets whether accessibility support is globally enabled for all DevExpress web controls across the web page or the entire web site. Inherited from ASPxWebControl.
GlobalCheckReferencesToExternalScripts staticGets or sets whether links to external client scripts (such as jQuery, Knockout, and others), which are used by some DevExpress web components, are checked for presence and correctness. Inherited from ASPxWebControl.
GlobalEmbedRequiredClientLibraries staticObsolete. Gets or sets whether external client libraries (including scripts and CSS files) are automatically embedded in the DevExpress.Web assembly as resources. Inherited from ASPxWebControl.
GlobalRightToLeft staticGets or sets that the right-to-left orientation shall be globally applied to all DevExpress web controls across the web page or the entire web site. Inherited from ASPxWebControl.
GlobalStyleSheetTheme staticGets or sets the name of the style sheet theme to be globally applied to all DevExpress web controls across the entire web site. Inherited from ASPxWebControl.
GlobalTheme staticGets or sets the name of the Theme to be globally applied to all DevExpress web controls across the entire web site. Inherited from ASPxWebControl.
GlobalThemeBaseColor staticGets or sets the base color for the theme to be globally applied to all DevExpress web controls across a web page or entire web site. Inherited from ASPxWebControl.
GlobalThemeFont staticGets or sets the font settings of the theme to be globally applied to all DevExpress web controls across a web page or entire web site. Inherited from ASPxWebControl.
HasAttributesGets a value indicating whether the control has attributes set. Inherited from WebControl.
HasChildViewState protectedGets a value indicating whether the current server control’s child controls have any saved view-state settings. Inherited from Control.
HeightGets or sets the height of the web server control. Inherited from ASPxWebControl.
IDGets or sets the programmatic identifier assigned to the server control. Inherited from Control.
IdSeparator protectedGets the character used to separate control identifiers. Inherited from Control.
InitializedGets a value indicating whether the web control has been initialized. Inherited from ASPxWebControlBase.
IsCallbackGets a value indicating whether the request is the result of a callback sent by the control. Inherited from ASPxWebControl.
IsChildControlStateCleared protectedGets a value indicating whether controls contained within this control have control state. Inherited from Control.
IsTrackingViewState protectedGets a value that indicates whether the server control is saving changes to its view state. Inherited from Control.
IsViewStateEnabled protectedGets a value indicating whether view state is enabled for this control. Inherited from Control.
LoadedIndicates whether a web control has been loaded into the Page object. Inherited from ASPxWebControlBase.
LoadViewStateByID protectedGets a value indicating whether the control participates in loading its view state by ID instead of index. Inherited from Control.
NamingContainerGets a reference to the server control’s naming container, which creates a unique namespace for differentiating between server controls with the same ID property value. Inherited from Control.
OffsetGets the offset of a hint.
PageGets a reference to the Page instance that contains the server control. Inherited from Control.
ParentGets a reference to the server control’s parent control in the page control hierarchy. Inherited from Control.
ParentImagesThis property is not in effect for the ASPxWebControl class. Inherited from ASPxWebControl.
ParentStylesThis property is not in effect for the ASPxWebControl class. Inherited from ASPxWebControl.
PositionGets or sets where a hint should be positioned.
RenderingCompatibilityGets a value that specifies the ASP.NET version that rendered HTML will be compatible with. Inherited from Control.
ShadowImage staticObsolete. Gets the shadow image properties. Inherited from ASPxWebControl.
ShowCalloutGets or sets a value that specifies whether a hint is displayed in a callout box.
SiteGets information about the container that hosts the current control when rendered on a design surface. Inherited from Control.
SkinIDGets or sets the skin to apply to the control. Inherited from WebControl.
SpriteCssFilePathGets or sets the path to a CSS file that defines the control’s sprite image settings.
StyleGets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control. Inherited from WebControl.
SupportsDisabledAttributeGets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to “disabled” when the control’s IsEnabled property is false. Inherited from WebControl.
IControlBuilderAccessor.ControlBuilderFor a description of this member, see ControlBuilder. Inherited from Control.
IControlDesignerAccessor.UserDataFor a description of this member, see UserData. Inherited from Control.
IDataBindingsAccessor.DataBindingsFor a description of this member, see DataBindings. Inherited from Control.
IDataBindingsAccessor.HasDataBindingsFor a description of this member, see HasDataBindings. Inherited from Control.
IExpressionsAccessor.ExpressionsFor a description of this member, see Expressions. Inherited from Control.
IExpressionsAccessor.HasExpressionsFor a description of this member, see HasExpressions. Inherited from Control.
TagKey protectedGets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers. Inherited from WebControl.
TagName protectedGets the name of the control tag. This property is used primarily by control developers. Inherited from WebControl.
TargetSelectorGets or sets a CSS selector string value.
TemplateControlGets or sets a reference to the template that contains this control. Inherited from Control.
TemplateSourceDirectoryGets the virtual directory of the Page or UserControl that contains the current server control. Inherited from Control.
ThemeGets or sets the name of the Theme to be applied to the control. Inherited from ASPxWebControl.
TitleGets or sets the hint’s title.
TitleAttributeGets or sets the target element attribute’s name from which a hint obtains its title text.
TriggerActionGets or sets which user action triggers a hint.
UniqueIDGets the unique, hierarchically qualified identifier for the server control. Inherited from Control.
ValidateRequestModeGets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. Inherited from Control.
ViewState protectedGets 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 Control.
ViewStateIgnoresCase protectedGets a value that indicates whether the StateBag object is case-insensitive. Inherited from Control.
ViewStateModeGets or sets the view-state mode of this control. Inherited from Control.
VisibleGets or sets a value that indicates whether a server control is rendered as UI on the page. Inherited from Control.
WidthGets or sets the width of the web server control. Inherited from ASPxWebControl.
XGets or sets the X coordinate.
YGets or sets the Y coordinate.

Methods

NameDescription
AddAttributesToRender(HtmlTextWriter) protectedAdds HTML attributes and styles that need to be rendered to the specified HtmlTextWriterTag. This method is used primarily by control developers. Inherited from WebControl.
AddedControl(Control, Int32) protectedCalled after a child control is added to the Controls collection of the Control object. Inherited from Control.
AddParsedSubObject(Object) protectedNotifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control’s ControlCollection object. Inherited from Control.
ApplyStyle(Style)Copies 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 WebControl.
ApplyStyleSheetSkin(Page)Applies the style properties defined in the page style sheet to the control. Inherited from Control.
BeginRenderTracing(TextWriter, Object) protectedBegins design-time tracing of rendering data. Inherited from Control.
BuildProfileTree(String, Boolean) protectedGathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page. Inherited from Control.
ClearCachedClientID() protectedSets the cached ClientID value to null. Inherited from Control.
ClearChildControlState() protectedDeletes the control-state information for the server control’s child controls. Inherited from Control.
ClearChildState() protectedDeletes the view-state and control-state information for all the server control’s child controls. Inherited from Control.
ClearChildViewState() protectedDeletes the view-state information for all the server control’s child controls. Inherited from Control.
ClearEffectiveClientIDMode() protectedSets the ClientIDMode property of the current control instance and of any child controls to Inherit. Inherited from Control.
CopyBaseAttributes(WebControl)Copies the properties not encapsulated by the 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 WebControl.
CreateControlCollection() protectedCreates a new ControlCollection object to hold the child controls (both literal and server) of the server control. Inherited from Control.
DataBind()Binds the data source to the invoked server control. Inherited from ASPxWebControl.
DataBind(Boolean) protectedBinds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event. Inherited from Control.
DataBindChildren() protectedBinds a data source to the server control’s child controls. Inherited from Control.
Dispose()Enables a server control to perform final clean up before it is released from memory. Inherited from Control.
EndRenderTracing(TextWriter, Object) protectedEnds design-time tracing of rendering data. Inherited from Control.
EnsureID() protectedCreates an identifier for controls that do not have an identifier assigned. Inherited from Control.
Equals(Object, Object) staticDetermines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object)Determines whether the specified object is equal to the current object. Inherited from Object.
FindControl(String, Int32) protectedSearches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the FindControl method. Inherited from Control.
FindControl(String)Searches the current naming container for a server control with the specified id parameter. Inherited from Control.
Focus()Sets input focus to the web control. Inherited from ASPxWebControl.
GetCallbackErrorMessage() staticObtains the error info while processing the redirection page. Inherited from ASPxWebControl.
GetClientSideEventHandler(String)Returns the specified client event’s handler. Inherited from ASPxWebControl.
GetCssClassNamePrefix()For internal use only. Inherited from ASPxWebControl.
GetCssClassNamePrefix(String)For internal use only. Inherited from ASPxWebControl.
GetDefaultBooleanProperty(String, DefaultBoolean)For internal use only. Inherited from ASPxWebControl.
GetDesignModeState() protectedGets design-time data for a control. Inherited from Control.
GetHashCode()Serves as the default hash function. Inherited from Object.
GetResourceUrl(Page, String) staticReturns a URL reference to an embedded resource in an assembly. Inherited from ASPxWebControl.
GetResourceUrl(Page, Type, String) staticReturns a URL reference to an embedded resource in an assembly. Inherited from ASPxWebControl.
GetRouteUrl(Object)Gets the URL that corresponds to a set of route parameters. Inherited from Control.
GetRouteUrl(String, Object)Gets the URL that corresponds to a set of route parameters and a route name. Inherited from Control.
GetRouteUrl(String, RouteValueDictionary)Gets the URL that corresponds to a set of route parameters and a route name. Inherited from Control.
GetRouteUrl(RouteValueDictionary)Gets the URL that corresponds to a set of route parameters. Inherited from Control.
GetType()Gets the Type of the current instance. Inherited from Object.
GetUniqueIDRelativeTo(Control)Returns the prefixed portion of the UniqueID property of the specified control. Inherited from Control.
HasControls()Determines if the server control contains any child controls. Inherited from Control.
HasEvents() protectedReturns a value indicating whether events are registered for the control or any child controls. Inherited from Control.
HtmlEncode(String, Boolean)For internal use only. Inherited from ASPxWebControl.
HtmlEncode(String)For internal use only. Inherited from ASPxWebControl.
IsAccessibilityCompliantRender()Returns a value that indicates whether the control’s accessible html code is rendered. Inherited from ASPxWebControl.
IsAccessibilityCompliantRender(Boolean)Returns a value that indicates whether the control’s accessible html code is rendered. Inherited from ASPxWebControl.
IsClientSideAPIEnabled()Returns a value that indicates whether a specific programmatic interface (in particular, specific JavaScript objects and methods) are available to the control on the client side. Inherited from ASPxWebControl.
IsEnabled()Returns a value that specifies whether a web control is enabled. Inherited from ASPxWebControlBase.
IsLiteralContent() protectedDetermines if the server control holds only literal content. Inherited from Control.
IsLoading()This member supports the internal infrastructure and is not intended to be used directly from your code. Inherited from ASPxWebControl.
IsVisible()Returns a value that specifies whether the current web control is displayed. Inherited from ASPxWebControlBase.
LoadControlState(Object) protectedRestores control-state information from a previous page request that was saved by the SaveControlState() method. Inherited from Control.
MakeResponseCompressed() staticSpecifies that the response code (the HTML code of the web page) should be compressed on the server before sending it to the client. Inherited from ASPxWebControl.
MakeResponseCompressed(Boolean) staticSpecifies that the response code (the HTML code of the web page) should be compressed on the server before sending it to the client, and accepts a parameter specifying whether to apply compression to IE6. Inherited from ASPxWebControl.
MapPathSecure(String) protectedRetrieves the physical path that a virtual path, either absolute or relative, maps to. Inherited from Control.
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
MergeStyle(Style)Copies 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 WebControl.
OnBubbleEvent(Object, EventArgs) protectedDetermines whether the event for the server control is passed up the page’s UI server control hierarchy. Inherited from Control.
OnDataBinding(EventArgs) protectedRaises the DataBinding event. Inherited from Control.
OnUnload(EventArgs) protectedRaises the Unload event. Inherited from Control.
OpenFile(String) protectedGets a Stream used to read a file. Inherited from Control.
RaiseBubbleEvent(Object, EventArgs) protectedAssigns any sources of the event and its information to the control’s parent. Inherited from Control.
RedirectOnCallback(String) staticRedirects a client to a new URL while processing a callback. Inherited from ASPxWebControl.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
RegisterBaseScript(Page, Boolean) staticRegisters base scripts required to embed an ASPxWebControl control onto the specified page. Inherited from ASPxWebControl.
RegisterBaseScript(Page) staticRegisters base scripts, required to embed an ASPxWebControl control onto the specified page. Inherited from ASPxWebControl.
RegisterUtilsScript(Page) staticObsolete. Registers utils scripts required to embed an ASPxWebControl control onto the specified page. Inherited from ASPxWebControl.
RemovedControl(Control) protectedCalled after a child control is removed from the Controls collection of the Control object. Inherited from Control.
RenderBeginTag(HtmlTextWriter)Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers. Inherited from WebControl.
RenderChildren(HtmlTextWriter) protectedOutputs the content of a server control’s children to a provided HtmlTextWriter object, which writes the content to be rendered on the client. Inherited from Control.
RenderContents(HtmlTextWriter) protectedRenders the contents of the control to the specified writer. This method is used primarily by control developers. Inherited from WebControl.
RenderControl(HtmlTextWriter, ControlAdapter) protectedOutputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. Inherited from Control.
RenderControl(HtmlTextWriter)Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. Inherited from Control.
RenderEndTag(HtmlTextWriter)Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers. Inherited from WebControl.
RequireClientLibrariesRegistering() staticSpecifies whether client library registration is required. Inherited from ASPxWebControl.
ResolveAdapter() protectedGets the control adapter responsible for rendering the specified control. Inherited from Control.
ResolveClientUrl(String)Gets a URL that can be used by the browser. Inherited from ASPxWebControlBase.
ResolveUrl(String)Converts a URL into one that is usable on the requesting client. Inherited from Control.
SaveControlState() protectedSaves any server control state changes that have occurred since the time the page was posted back to the server. Inherited from Control.
SetCallbackErrorMessage(String) staticSpecifies the message text to be displayed for remote clients when a DevExpress control callback error has occurred. Inherited from ASPxWebControl.
SetClientSideEventHandler(String, String)Defines a handler for the specified client event. Inherited from ASPxWebControl.
SetDesignModeState(IDictionary) protectedSets design-time data for a control. Inherited from Control.
SetRenderMethodDelegate(RenderMethod)Assigns an event handler delegate to render the server control and its content into its parent control. Inherited from Control.
SetTraceData(Object, Object, Object)Sets trace data for design-time tracing of rendering data, using the traced object, the trace data key, and the trace data value. Inherited from Control.
SetTraceData(Object, Object)Sets trace data for design-time tracing of rendering data, using the trace data key and the trace data value. Inherited from Control.
IAttributeAccessor.GetAttribute(String)Gets an attribute of the Web control with the specified name. Inherited from WebControl.
IAttributeAccessor.SetAttribute(String, String)Sets an attribute of the Web control to the specified name and value. Inherited from WebControl.
IControlDesignerAccessor.GetDesignModeState()For a description of this member, see GetDesignModeState(). Inherited from Control.
IControlDesignerAccessor.SetDesignModeState(IDictionary)For a description of this member, see SetDesignModeState(IDictionary). Inherited from Control.
IControlDesignerAccessor.SetOwnerControl(Control)For a description of this member, see SetOwnerControl(Control). Inherited from Control.
IParserAccessor.AddParsedSubObject(Object)For a description of this member, see AddParsedSubObject(Object). Inherited from Control.
ToString()Returns a string that represents the current object. Inherited from Object.

Events

NameDescription
CallbackError staticAllows you to handle any server exception that might occur during server-side processing of a callback sent by a DevExpress web control. Inherited from ASPxWebControl.
DataBindingOccurs when the server control binds to a data source. Inherited from Control.
DisposedOccurs 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 Control.
InitOccurs when the server control is initialized, which is the first step in its lifecycle. Inherited from Control.
LoadOccurs when the server control is loaded into the Page object. Inherited from Control.
PreRenderOccurs after the Control object is loaded but prior to rendering. Inherited from Control.
UnloadOccurs when the server control is unloaded from memory. Inherited from Control.

See Also

ASPxHint Class

DevExpress.Web Namespace