Share via


PopulateHelpContent Method [Office 2003 SDK Documentation]

The PopulateHelpContent method specifies the content of help text, in HTML format, that is displayed in the Document Actions task pane. You can provide either the HTML or a URL to a file that contains the HTML. Applies to controls that are specified as C_TYPE_HELP and C_TYPE_HELPURL.

Applies to

ISmartDocument

Syntax

[Visual Basic 6.0]

Private Sub ISmartDocument_PopulateHelpContent(ByVal ControlID As Long, ByVal ApplicationName As String, ByVal LocaleID As Long, ByVal Text As String, ByVal Xml As String, ByVal Target As Object, ByVal Props As SmartTagLib.ISmartDocProperties, Content As String)

[Visual Basic .NET]

Public Sub PopulateHelpContent(ByVal ControlID As Integer, ByVal ApplicationName As String, ByVal LocaleID As Integer, ByVal [Text] As String, ByVal Xml As String, ByVal Target As Object, ByVal Props As Microsoft.Office.Interop.SmartTag.ISmartDocProperties, ByRef Content As String) Implements Microsoft.Office.Interop.SmartTag.ISmartDocument.PopulateHelpContent

[C#]

public void ISmartDocument.PopulateHelpContent(int ControlID, string ApplicationName, int LocaleID, string Text, string Xml, object Target, Microsoft.Office.Interop.SmartTag.ISmartDocProperties Props, ref string Content)

[Visual C++ 6.0]

STDMETHOD(PopulateHelpContent)(INT ControlID, BSTR ApplicationName, INT LocaleID, BSTR Text, BSTR Xml, IDispatch * Target, ISmartDocProperties * Props, BSTR * Content)

[Visual C++ .NET]

STDMETHOD(PopulateHelpContent)(int ControlID, BSTR ApplicationName, int LocaleID, BSTR Text, BSTR Xml, LPDISPATCH Target, ISmartDocProperties * Props, BSTR * Content)

Parameters

ControlID   Represents the ID number assigned to a control in the ControlID property.

ApplicationName   Specifies the name of the application. You can use the ****ApplicationName parameter to customize a single smart document DLL to provide smart document actions in multiple Microsoft Office applications.

LocaleID   Represents the language setting of the application. You can use the LocaleID parameter to specify different actions for multiple languages in a smart document.

Text   The text contained in the XML element with which the control is associated.

Xml Specifies the XML element, including the markup and data, with which the control is associated.

Target   Specifies the Microsoft Word or Microsoft Excel Range object that represents the XML element for which the action is defined.

Props   Returns an ISmartDocProperties collection that represents the properties, such as height or width, for the control.

Content   Represents the help text or the URL to a file that contains the help text. If a control is specified as C_TYPE_HELP, this parameter provides the content for the help text. If a control is specified as C_TYPE_HELPURL, this parameter provides a URL to the file that contains the help text. The URL must be an absolute path; it cannot be a relative path.

Remarks

Not all HTML elements are permitted when displaying Help text in the Document Actions task pane. For information about the HTML elements that are allowed, see Using Help Controls.

From within this method, you cannot refresh the task pane by using the RefreshPane method for the SmartDocument object. If you need to refresh the task pane, use the OnPaneUpdateComplete method.

Note  The RefreshPane method and the SmartDocument object are part of the Microsoft Office Word 2003 and Microsoft Office Excel 2003 Visual Basic for Applications (VBA) object models.