IHTMLOptionsHolder

IHTMLOptionsHolder


This interface provides the access methods to pass and control the contents and characteristics of a dialog window.

This object is a container for various options that can to be passed as arguments into a dialog windows presented from the browser.

IHTMLOptionsHolder Methods
get_document   get_fonts   put_execArg  
get_execArg   put_errorLine   get_errorLine  
put_errorCharacter   get_errorCharacter   put_errorCode  
get_errorCode   put_errorMessage   get_errorMessage  
put_errorDebug   get_errorDebug   put_productVersion  
get_productVersion   get_unsecuredWindowOfDocument   put_findText  
get_findText   sizes   openfiledlg  
savefiledlg   choosecolordlg   showSecurityInfo  

IHTMLOptionsHolder::get_document

HRESULT get_document(
    IHTMLDocument2 **p 
);

Returns a pointer to the document that the dialog is parented by.

p
Address of a variable that receives an interface pointer to the IHTMLDocument2 object.

IHTMLOptionsHolder::get_fonts

HRESULT get_fonts(
    IHTMLFontNamesCollection **p 
);

Returns a IHTMLFontNamesCollection pointer for a collection of all the system-supported fonts.

p
Address of a variable that receives an interface pointer to the IHTMLFontNamesCollection object.

IHTMLOptionsHolder::put_execArg

HRESULT put_execArg( 
    VARIANT v 
);

Sets the variant argument; this allows additional user-data parameters to be passed in.

v
VARIANT structure that contains the script to be set.

See also get_execArg

IHTMLOptionsHolder::get_execArg

HRESULT get_execArg( 
    VARIANT *p 
);

Retrieves the variant argument of any additional parameters that were passed in.

p
Address of a VARIANT structure that contains the arguments.

See also put_execArg

IHTMLOptionsHolder::put_errorLine

HRESULT put_errorLine(
    long v 
);

Sets the inline script associated with the onerror event on the IHTMLOptionsHolder element. This value indicates the line number that an error occurred at and is generally used to report script errors.

v
VARIANT structure that contains the script to be set.

For more information on inline script, see Attaching an Event Handler in the Understanding the Event Model documentation.

See also get_errorLine

IHTMLOptionsHolder::get_errorLine

HRESULT get_errorLine(
    long *p 
);

Retrieves the inline script associated with the onerror event on the IHTMLOptionsHolder element. This value indicates the line number that an error occurred at and is generally used to report script errors.

p
Address of a VARIANT structure that contains the script.

For more information on inline script, see Attaching an Event Handler in the Understanding the Event Model documentation.

See also put_errorLine

IHTMLOptionsHolder::put_errorCharacter

HRESULT put_errorCharacter(
    long v 
);

Sets the count of the character on the line where an error occurred.

v
Value specifying the error code.

See also get_errorCharacter

IHTMLOptionsHolder::get_errorCharacter

HRESULT get_errorCharacter(
    long *p
);

Retrieves the count of the character on the line where an error occurred.

p
Address of a variable that receives the error code.

See also put_errorCharacter

IHTMLOptionsHolder::put_errorCode

HRESULT put_errorCode(
    long v 
);

Sets the error code for the error being reported.

v
Value specifying the error code.

See also get_errorCode

IHTMLOptionsHolder::get_errorCode

HRESULT get_errorCode(
    long *p 
);

Retrieves the current error code for the error being reported.

p
Address of a variable that receives the error code.

See also put_errorCode

IHTMLOptionsHolder::put_errorMessage

HRESULT put_errorMessage(
    BSTR v 
);

Sets the string text for the error message to be displayed.

v
String variable specifying the error text.

See also get_errorMessage

IHTMLOptionsHolder::get_errorMessage

HRESULT get_errorMessage(
    BSTR *p 
);

Retrieves the string text of the error message to be displayed.

p
Address of a string variable that receives the error text.

See also put_errorMessage

IHTMLOptionsHolder::put_errorDebug

HRESULT put_errorDebug(
    VARIANT_BOOL v 
);

Set the Boolean value indicating whether to debug this error or not.

v
Boolean value specifying whether to debug this error. If set to TRUE, the error is debugged; if FALSE, it is not.

See also get_errorDebug

IHTMLOptionsHolder::get_errorDebug

HRESULT get_errorDebug(
    VARIANT_BOOL *p 
);

Retrieves the Boolean value indicating whether to debug this error.

p
Address of a variable that receives TRUE to debug this error, or FALSE to not.

See also put_errorDebug

IHTMLOptionsHolder::put_productVersion

HRESULT put_productVersion( 
    BSTR v 
);

Sets the string indicating the product version information.

v
String specifying the product version information.

See also get_productVersion

IHTMLOptionsHolder::get_productVersion

HRESULT get_productVersion(
    BSTR *p 
);

Retrieves the string indicating the product version information.

p
Address of a string variable that receives the product version information.

See also put_productVersion

IHTMLOptionsHolder::get_unsecuredWindowOfDocument

HRESULT get_unsecuredWindowOfDocument(
    IHTMLWindow2 **p 
);

Retrieves the IHTMLWindow2 interface pointer to the parent document's window. This in not wrapped by a security proxy, thus is not considered secure.

p
Address of a variable that receives the interface pointer for the IHTMLWindow2 interface.

IHTMLOptionsHolder::put_findText

HRESULT put_findText( 
    BSTR v 
);

Sets the text with which to seed a find operation.

v
String value specifying the text used for the search operation.

See also get_findText

IHTMLOptionsHolder::get_findText

HRESULT get_findText(
    BSTR *p 
);

Retrieves the text used in a find operation.

p
Address of a string variable that contains the text used for the search operation.

See also put_findText

IHTMLOptionsHolder::sizes

HRESULT sizes( 
    BSTR fontName,
    IHTMLFontSizesCollection **pSizesCollection 
);

Receives the IHTMLFontSizesCollection pointer to a collection of the sizes available for the font that is passed in as a parameter.

fontName
String value specifying the name of the font from which to obtain the font size information.
pSizesCollection
Address of a variable that receives the interface pointer for the IHTMLFontSizesCollection element.

IHTMLOptionsHolder::openfiledlg

HRESULT openfiledlg( 
    VARIANT initFile,
    VARIANT initDir,
    VARIANT filter,
    VARIANT title,
    BSTR *pathName 
);

Opens the system open file dialog window.

initFile
VARIANT structure containing the initial file name to open.
initDir
VARIANT structure containing the initial directory to open.
filter
VARIANT structure containing the filters to use in opening the file.
title
VARIANT structure containing the initial title for the file dialog window.
pathName
String variable specifying the path for the file to be opened.

See also savefiledlg

IHTMLOptionsHolder::savefiledlg

HRESULT savefiledlg( 
    VARIANT initFile,
    VARIANT initDir,
    VARIANT filter,
    VARIANT title,
    BSTR *pathName 
);

Opens the system save file dialog.

initFile
VARIANT structure containing the file name to save the file.
initDir
VARIANT structure containing the directory to save the file.
filter
VARIANT structure containing the filters to use in saving the file.
title
VARIANT structure containing the initial title for the file dialog window.
pathName
String variable specifying the path for the file to be saved.

IHTMLOptionsHolder::choosecolordlg

HRESULT choosecolordlg( 
    VARIANT initColor,
    long *rgbColor 
);

Opens the system color picker dialog box.

initColor
VARIANT containing the name of the color in the color picker. For a complete list of colors, see Color Table.
rgbColor
Long integer specifying the value of the color in the color picker. For a complete list of colors, see Color Table.

IHTMLOptionsHolder::showSecurityInfo

HRESULT showSecurityInfo(
    void 
);

Opens the Internet security information dialog box for the zone based on the document's URL.

© 1997 Microsoft Corporation. All rights reserved. Terms of Use.