VI class/Help.Document Tag property

From LabVIEW Wiki
Jump to: navigation, search
VI Server Property Information
Property ID 214
Scope Basic Development Environment
Data Name Help.Tag
Short Name* Help.Tag
Long Name* Help:Document Tag
* Displayed here in English. Short and Long names appear in the language of the LabVIEW IDE.
Owning Class ID 2
Owning Class Name VI Class
Data Type String data type

String

Property Node Help:Document Tag
Available in Real-Time Operating SystemYes
Available in Run-Time EngineYes
Available with control VIsYes
Available with global VIsYes
Available with polymorphic VIsYes
Available with strict type definitionsNo
Loads the block diagram into memoryNo
Loads the front panel into memoryNo
Must wait until user interface is idleNo
Need to authenticate before useNo
PermissionsRead/Write
Remote access allowedYes
Settable when the VI is runningYes

Index keyword or HTML filename for a topic in the compiled help file to which the VI is linked.

Use this property only when Document Path is a path to a compiled help file (.chm or .hlp).

For .chm files, this property can be an HTML filename or index keyword. To link to a bookmark within an HTML file, add # followed by the name of the bookmark to the end of the filename. For .hlp files, this property can be an index keyword.

This property is similar to the Help Tag text box on the Documentation page of the VI Properties dialog box.


Uses

History

Version Change(s)
LabVIEW 2018 More info to come.

See Also

External Links