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.v20.1.dll

Declaration

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

Property Value

Type Default Description
String

String.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.

See Also