Back to Devexpress

ActionBase.ToolTip Property

expressappframework-devexpress-dot-expressapp-dot-actions-dot-actionbase-9bbbf324.md

latest4.0 KB
Original Source

ActionBase.ToolTip Property

Specifies a tooltip for an Action.

Namespace : DevExpress.ExpressApp.Actions

Assembly : DevExpress.ExpressApp.v25.2.dll

NuGet Package : DevExpress.ExpressApp

Declaration

csharp
[DefaultValue("")]
public string ToolTip { get; set; }
vb
<DefaultValue("")>
Public Property ToolTip As String

Property Value

TypeDefaultDescription
StringString.Empty

A string value that represents the current Action’s tooltip.

|

Remarks

Use the ToolTip property to specify a custom text for an Action’s tooltip. The tooltip is displayed when a user hovers a mouse over an Action.

By default, a tooltip is set to the ActionBase.Caption property value. You can set another value in the Controller’s constructor or Designer. This value will be saved to the Application Model‘s IModelAction node. You can change this value in the Model Editor.

When the property’s value changes, the ActionBase.Changed event is raised.

The following code snippets (auto-collected from DevExpress Examples) contain references to the ToolTip property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

XAF_How-to-get-role-code-from-the-UI/CS/XPO/GenerateRole/GenerateRole.Module/Controllers/RoleGeneratorController.cs#L29

csharp
roleGeneratorAction.ImageName = "Action_Export";
roleGeneratorAction.ToolTip = null;
roleGeneratorAction.Execute += new SimpleActionExecuteEventHandler(RoleGeneratorAction_Execute);

XAF_logon-form-manage-users-register-a-new-user-restore-a-password/CS/EFCore/Security.Extensions/ManageUsersOnLogonController.cs#L56

csharp
action.PaintStyle = ActionItemPaintStyle.Image;
action.ToolTip = toolTip;
action.Execute += (s, e) => CreateParametersViewCore(e);

See Also

How to: Modify Action Properties in the Model Editor

GetTotalToolTip

ActionBase Class

ActionBase Members

DevExpress.ExpressApp.Actions Namespace