filterpriority

Sandcastle XML Comments

Sandcastle XML Comments Guide filterpriority

This element is used by the Visual Basic editor to control the IntelliSense visibility for methods and properties. It has no effect on the appearance of the topic in the compiled help file.

Syntax

This top-level element can be used on methods and properties.

<filterpriority>1 | 2 | 3</filterpriority>
Remarks

This element determines how a member appears in Visual Basic IntelliSense. A value of 1 means that it should appear in the Common tab, 2 means it should appear in the All tab, and 3 means it should be hidden from IntelliSense completely.

Note Note

This is effectively equivalent to using EditorBrowsableAttribute. However, unlike the attribute, the XML comments element only has effect in Visual Basic and is ignored by all other languages. As such, it is rarely used. The most common place to see it is in the XML comments for the base .NET Framework classes themselves.

Example
/// <summary>
/// Filter priority example
/// </summary>
/// <remarks>This element is rarely used as <see cref="EditorBrowsableAttribute"/>
/// does the same thing and is effective across all languages.</remarks>
/// <filterpriority>1</filterpriority>
/// <conceptualLink target="0522f3bf-0a57-4d70-a2a5-d64a14c5bcc9" />
public void FilterPriorityExample()
{
}
See Also

Reference

Other Resources