Share via


WizardPage.Description Property

Definition

Gets or sets the description of a form, wizard page, or other object.

public:
 property System::String ^ Description { System::String ^ get(); void set(System::String ^ value); };
public string Description { get; set; }
member this.Description : string with get, set
Public Property Description As String

Property Value

The description text. The default is an empty string.

Examples

The following example demonstrates the Description property. This example sets the description to the page name. This code example is part of a larger example provided for the WizardPage class.

protected override void Activate()
{
    _description = this.Name;
    _caption = "Original Caption";
    this.button4.Text = "Change R to L Layout : currently " + RightToLeft.ToString();
}
// Customize the Description Property.
public new string Description
{
    get
    {
        return _description;
    }
    set
    {
        _description = value;
    }
}

Remarks

Use this property to update the description of the WizardPage object. The Description property contains a string that you can use wherever you need a description in the wizard form.

Applies to