GetExtraSharedProps Method

Returns the object held in extra shared props at the specified index.

Syntax

Visual Basic

'Declaration
 
Protected Function GetExtraSharedProps( _
   ByVal extraSharedPropsIndex As Integer _
) As Object

C#

protected object GetExtraSharedProps( 
   int extraSharedPropsIndex
)

Parameters

extraSharedPropsIndex

The index of the extra shared props to retrieve.

Return Value

The extra shared props at the specified index.

Remarks

ExtraSharedProps is an internal mechanism used to support extra properties that may be shared among tools derived from the existing tool classes. The operation of ExtraSharedProps does not change the properties of the SharedProps object. ExtraSharedProps is only useful for developers who are deriving their own tools from this class; its operation is transparent to the developer who is simply using the existing features of the control in their application.

The extraSharedPropsIndex should be taken from the base implementation's ExtraSharedPropsCount which should be overridden and incremented in each tool type providing its own extra shared props.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2