Export (0) Print
Expand All
ID
Top
Expand Minimize

IsPropertyHidden Property

Visual Studio .NET 2003

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

[Visual Basic .NET]
Public Function IsPropertyHidden( _
   ByVal PropertyName As String _
) As vsFilterProperties
[Visual Basic 6]
Function IsPropertyHidden( _
   ByVal PropertyName As String _
) As vsFilterProperties
[C++]
HRESULT __stdcall IsPropertyHidden(
   BSTR PropertyName,
   /* [out, retval] */ vsFilterProperties* retVal
);
[C#]
vsFilterProperties IsPropertyHidden(
   string PropertyName
);
[JScript .NET]
public function IsPropertyHidden(
   PropertyName : String
) : vsFilterProperties

Parameters

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

Return Value

The implementor should return a vsFilterProperties constant indicating whether or not the property is hidden or overridden.

Remarks

When the Properties window displays an object that has an IFilterProperties-supporting Extender, it invokes IFilterProperties::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 rather than removing it entirely, the Extender should return vsFilterPropertiesAll and also expose the same named property through its own IDispatch implementation with the restricted set of values.

See Also

Implementing and Using Automation Extenders | ObjectExtenders Object

Applies To: IFilterProperties Interface

Show:
© 2015 Microsoft