GelProperty::RegisterLazyInitializedProperty<TOwner> Method

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Microsoft internal use only.

Registers a property with a getter callback.

Namespace:  Microsoft.Internal.VisualStudio.PlatformUI
Assemblies:   Microsoft.VisualStudio.Shell.12.0 (in Microsoft.VisualStudio.Shell.12.0.dll)
  Microsoft.VisualStudio.Shell.11.0 (in Microsoft.VisualStudio.Shell.11.0.dll)

public:
generic<typename TOwner>
static GelProperty^ RegisterLazyInitializedProperty(
	String^ name, 
	String^ type, 
	__VSUIDATAFORMAT format, 
	GelPropertyGetterCallback^ getter
)

Type Parameters

TOwner

Owning type.

Parameters

name
Type: System::String

Name of the new property.

type
Type: System::String

Data type of the new property (VsUIType).

format
Type: Microsoft.VisualStudio.Shell.Interop::__VSUIDATAFORMAT

Data format of the new property.

getter
Type: Microsoft.Internal.VisualStudio.PlatformUI::GelPropertyGetterCallback

The getter function.

Return Value

Type: Microsoft.Internal.VisualStudio.PlatformUI::GelProperty
The registered property.

The getter function is invoked when the property's value is first needed (lazy initialized). After that, the value is cached for fast retrieval. However, the getter function will be called again if the property is reset through a call to ResetValue.

Show: