TextCommandPalette.htmlFileURL Property

Parent Object: TextCommandPalette
Defined in namespace "adsk::core" and the header file is <Core/UserInterface/TextCommandPalette.h>

Description

Gets and sets the URL to the HTML file that will be displayed in the palette. This can be a local file or a URL on the web where the HTML will be read. To avoid reading a file, this can also be the full HTML definition as a string.

If you are providing the HTML content as a string, it should begin with the element. Any references made in the HTML should be to URL's and not local files since the local path is ambiguous.

Syntax

"textCommandPalette_var" is a variable referencing a TextCommandPalette object.

# Get the value of the property.
propertyValue = textCommandPalette_var.htmlFileURL

# Set the value of the property.
textCommandPalette_var.htmlFileURL = propertyValue
"textCommandPalette_var" is a variable referencing a TextCommandPalette object.
#include <Core/UserInterface/TextCommandPalette.h>

// Get the value of the property.
string propertyValue = textCommandPalette_var->htmlFileURL();

// Set the value of the property, where value_var is a string.
bool returnValue = textCommandPalette_var->htmlFileURL(value_var);

Property Value

This is a read/write property whose value is a string.

Version

Introduced in version August 2017