GetCachedProperty Method (ComponentRole)

Returns cached resolved value for the property identified by the propertyIndex. The propertyIndex parameter must be less than the value set on the PropertiesCacheCount property of this component role. Also note that whenever the control property value changes, the cache needs to be cleared using the ClearCachedPropertyValues method.

Syntax

Visual Basic

'Declaration
 
Public Function GetCachedProperty( _
   ByVal propertyIndex As Integer, _
   ByRef value As Object _
) As Boolean

C#

public bool GetCachedProperty( 
   int propertyIndex,
   out object value
)

Parameters

propertyIndex

The index that uniquely identifies the property whose cached resolved value to get. The propertyIndex parameter must be less than the value set on the PropertiesCacheCount property of this component role.

value

This out parameter will be assigned the cached resolved value of the property.

Return Value

Returns true if the resolved value of the property is cached. If false then you need to cache it using the CachePropertyValue(Int32,String,Object,Object,Object) method.

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