Back to Devexpress

RibbonControl.ApplicationCaption Property

windowsforms-devexpress-dot-xtrabars-dot-ribbon-dot-ribboncontrol-d201f267.md

latest3.8 KB
Original Source

RibbonControl.ApplicationCaption Property

Gets or sets the second portion of the RibbonForm’s caption which generally specifies the name of the current application.

Namespace : DevExpress.XtraBars.Ribbon

Assembly : DevExpress.XtraBars.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

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

Property Value

TypeDefaultDescription
StringString.Empty

A string which specifies the second portion of the RibbonForm’s caption.

|

Remarks

The ApplicationCaption and RibbonControl.ApplicationDocumentCaption properties are in effect when the Ribbon Control is used within a RibbonForm. Otherwise, these properties are ignored.

The form’s caption may consist of two portions separated by a dash. The first portion ( ApplicationDocumentCaption ) generally specifies the name of the document currently open, or the name of the active document. The second portion ( ApplicationCaption ) generally specifies the name of the application. For instance, if ApplicationDocumentCaption is set to “WindowsApplication1”, and ApplicationCaption is set to “Microsoft Visual Studio”, the form’s total caption will be “WindowsApplication1 - Microsoft Visual Studio”.

If the ApplicationCaption property is set to an empty string the form’s total caption will be a combination of the RibbonControl’s ApplicationDocumentCaption string and the RibbonForm’s Text property’s value.

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ApplicationCaption 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-create-information-panels/CS/EFCore/InfoPanelEF/InfoPanelEF.Win/LightStyleMainRibbonForm1.cs#L134

csharp
void IWindowTemplate.SetCaption(string caption) {
    ribbonControl.ApplicationCaption = " ";
    ribbonControl.ApplicationDocumentCaption = caption;

See Also

ApplicationDocumentCaption

RibbonForm

Ribbon Form

RibbonControl Class

RibbonControl Members

DevExpress.XtraBars.Ribbon Namespace