IsCaptionDynamic Property [Office 2003 SDK Documentation]

Determines whether a particular caption is dynamic.

Applies To

ISmartTagAction2

Syntax

[Visual Basic 6.0]

Private Property Get ISmartTagAction2_IsCaptionDynamic(ByVal VerbID As Long, ByVal ApplicationName As String, ByVal LocaleID As Long) As Boolean

[Visual C++ 6.0]

STDMETHODIMP CSTAction:: get_IsCaptionDynamic)(INT VerbID, BSTR ApplicationName, INT LocaleID, VARIANT_BOOL * Dynamic)

[Visual Basic .NET]

Public ReadOnly Property IsCaptionDynamic(ByVal VerbID As Integer, ByVal ApplicationName As String, ByVal LocaleID As Integer) As Boolean Implements Microsoft.Office.Interop.SmartTag.ISmartTagAction2.IsCaptionDynamic

[Visual C#]

public bool get_IsCaptionDynamic(int VerbID, string ApplicationName, int LocaleID)

Parameters

VerbID  An integer previously specified with the VerbID method.

ProgID

LocaleID  The language identifier that corresponds to the UI language of the calling application. A verb can customize its caption for the LocaleID, return Null, or return an empty string ("") to specify that the verb does not work under the respective LocaleID.

Remarks

The IsCaptionDynamic function gives smart tag developers the options and flexibility to choose appropriate action names for display on the smart tag action menu. It also allows smart tag developers to have actions that are not relevant for particular instances of a smart tag type to hide themselves.

If an action handler supports the new ISmartTagAction2 interface, before the VerbCaptionFromID2 function is called, the new IsCaptionDynamic function will be called first to determine whether any of the smart tag actions are dynamic. If the action handler returns true for the IsCaptionDynamic property for a particular smart tag action, the VerbCaptionFromID2 property is used to check repeatedly for new captions. If it returns false, or does not support this process, the static caption will be used, as in Office XP.