Share via


ModuleListPageFilter.Description Property

Definition

Gets the description of the filter.

public:
 property System::String ^ Description { System::String ^ get(); };
public string Description { get; }
member this.Description : string
Public ReadOnly Property Description As String

Property Value

The filter description.

Examples

The following example uses the Description property to set the text of a label.

LinkLabel _removeFilterLabel;
LinkLabel _filterLinkLabel; 
protected void RefreshMyFilter() {

    ModuleListPageFilter filter = this.Filter;

    if (filter != null) {
        if (filter.CanRemove) {

            _removeFilterLabel.Visible = true;
            _filterLinkLabel.Text = filter.Description;
            _removeFilterLabel.LinkArea =
                new LinkArea(0, _removeFilterLabel.Text.Length);
        } else {
            _filterLinkLabel.Text = filter.Description;
        }

        _filterLinkLabel.Links.Add(new LinkLabel.Link(0, 0));

        _filterLinkLabel.Visible = true;
        _selectedFilter = filter;
    } else {
        _filterLinkLabel.Visible = false;
        _removeFilterLabel.Visible = false;
    }
} 

Applies to