| Dialog Helper | NN n/a IE 6(Win) DOM n/a | |
|
The Dialog Helper object is an ActiveX control delivered with IE 6 for Windows that provides a short assortment of potentially useful system and document information; the method also displays a color selector dialog from which your scripts can obtain a user's color choice. Most typically, it would be used when scripting IE's edit mode, where users need to make color, font, and element choices. But you might find the object's properties and methods useful in traditional browser document settings. |
||
Loading this object into the page requires the following <object> tag: <object id="dlgHelper" classid="clsid:3050f819-98b5-11cf-bb82-00aa00bdce0b"
width="0px" height="0px>
</object> "
|
||
Because this object is not rendered, you may place its tag in the head portion of your document. You may also assign your choice of identifier to the id attribute. Once the object is loaded, reference it as a global object in the window. |
||
| HTML Equivalent | ||
None. |
||
| Object Model Reference | ||
[window.]document.getElementById("elementID")
|
||
| Object-Specific Properties | ||
|
||
| Object-Specific Methods | ||
|
||
| Object-Specific Event Handler Properties | ||
None. |
||
| blockFormats | NN n/a IE 6 DOM n/a |
| Read-only | |
|
Returns a collection of plain-language names of block-level elements supported by the browser. Unlike other IE collections, to read the number of items, you must access its Count property, rather than length property. The names of items returned are strings, such as "Heading 1" and "Numbered List" (corresponding to the h1 and ol elements, respectively). Access each item in the collection via the collection's item( ) method. |
|
| Example | |
var blockList = dlgHelper.blockFormats;
var blockNames = new Array( );
for (var i = 0; i < blockList.Count; i++) {
blockNames[blockNames.length]= blockList.item(i);
}
|
|
| Value | |
Array of strings |
|
| Default | |
Implementation-dependent. |
|
| fonts | NN n/a IE 6 DOM n/a |
| Read-only | |
|
Returns a collection of plain-language names of system fonts. Unlike other IE collections, to read the number of items, you must access its Count property, rather than length property. The names of items returned are strings, such as "MS Sans Serif" and "Verdana". Access each item in the collection via the collection's item( ) method. |
|
| Example | |
var fontList = dlgHelper.fonts;
var fontNames = new Array( );
for (var i = 0; i < fontList.Count; i++) {
fontNames [fontNames .length]= fontList .item(i);
}
|
|
| Value | |
Array of strings |
|
| Default | |
Implementation-dependent. |
|
| ChooseColorDlg( ) | NN n/a IE 6 DOM n/a |
ChooseColorDlg([initialHexColor]) | |
|
Displays a color selector dialog box, and returns a decimal number corresponding to the color chosen by the user. To apply the color to style or other color property settings, you may have to convert the decimal value to a suitable hexadecimal triplet value of the #RRGGBB format. The following fragment demonstrates the sequence of obtaining the color, converting it to the desired base and digit count, and assigning the value to a style property: var colorChoice = dlgHelper.ChooseColorDlg( );
var hexColor = colorChoice.toString(16);
while (hexColor.length< 6) {hexColor = "0" + hexColor;}
document.body.style.color = "#" + hexColor;
|
|
If the user selects a custom color in the dialog and adds it to a little shortcut box, the color does not reappear in the box the next time the dialog appears. But a custom color can still be pre-selected by passing its hex value as a parameter to the method. |
|
| Parameters | |
|
|
| Returned Value | |
Decimal integer of the selected color (0 through as many colors of the client settings). |
|
| getCharset( ) | NN n/a IE 6 DOM n/a |
getCharset("fontName") | |
|
Returns an integer corresponding to a constant associated with a character set known by the operating system. Among the common values returned for font families installed on Latin-based systems are 0 (for plain ANSI character set) and 2 (for a symbol set). The required parameter is the name of a font to inspect for its character set. Such names may be retrieved from the fonts property of the Dialog Helper object: var setID = dlgHelper.getCharset(dlgHelper.fonts.item(4)); |
|
Not all Windows versions have the same character set suite installed. |
|
| Parameters | |
|
|
| Returned Value | |
Integer. |
|