IFilterProperties.IsPropertyHidden(String) Method

Reference

Definition

Namespace:: EnvDTE

Assembly:: EnvDTE.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns whether the specified property is filtered (hidden or overridden) in the Properties window.

public:
 EnvDTE::vsFilterProperties IsPropertyHidden(System::String ^ PropertyName);

public:
 EnvDTE::vsFilterProperties IsPropertyHidden(Platform::String ^ PropertyName);

EnvDTE::vsFilterProperties IsPropertyHidden(std::wstring const & PropertyName);

[System.Runtime.InteropServices.DispId(1)]
public EnvDTE.vsFilterProperties IsPropertyHidden (string PropertyName);

[<System.Runtime.InteropServices.DispId(1)>]
abstract member IsPropertyHidden : string -> EnvDTE.vsFilterProperties

Public Function IsPropertyHidden (PropertyName As String) As vsFilterProperties

Parameters

PropertyName: String

The name of the property being queried to determine whether or not it is hidden or overridden in the Properties window.

Returns

vsFilterProperties

A vsFilterProperties constant indicating whether or not the property is hidden or overridden.

Attributes: DispIdAttribute

Remarks

When the Properties window displays an object that has an Extender that supports IFilterProperties, it invokes IsPropertyHidden on each browsable property that the object exposes. If this method returns vsFilterPropertiesAll, the property is hidden. If it returns vsFilterPropertiesSet, the property is made read-only. If it returns vsFilterPropertiesNone, the property is displayed in the window.

To restrict the values of a property, the Extender must return vsFilterPropertiesAll and also expose the same named property through its own IDispatch implementation with the restricted set of values.

Applies to

Sdílet prostřednictvím