IAgentPropertySheet

IAgentPropertySheet defines an interface that allows applications to set and query properties for the Microsoft Agent property sheet (window).

Methods in Vtable Order

IAgentPropertySheet Methods	Description
GetVisible	Returns whether the Microsoft Agent property sheet is visible.
SetVisible	Sets the Visible property of the Microsoft Agent property sheet.
GetPosition	Returns the position of the Microsoft Agent property sheet.
GetSize	Returns the size of the Microsoft Agent property sheet.
GetPage	Returns the current page for the Microsoft Agent property sheet.
SetPage	Sets the current page for the Microsoft Agent property sheet.

IAgentPropertySheet::GetPage

HRESULT GetPage(
BSTR * pbszPage  // address of variable for current property page
);

Retrieves the current page of the Microsoft Agent property sheet.

Returns S_OK to indicate the operation was successful.

pbszPage

Address of a variable that receives the current page of the property sheet (last viewed page if the window is not open). The parameter can be one of the following:

"Speech"	The Speech Recognition page.
"Output"	The Output page.
"Copyright"	The Copyright page.

See also IAgentPropertySheet::SetPage

IAgentPropertySheet::GetPosition

HRESULT GetPosition(
   long * plLeft,  // address of variable for left edge of property sheet
   long * plTop    // address of variable for top edge of property sheet
);

Retrieves the Microsoft Agent's property sheet window position.

Returns S_OK to indicate the operation was successful.

plLeft

Address of a variable that receives the screen coordinate of the left edge of the property sheet in pixels, relative to the screen origin (upper left).

plTop

Address of a variable that receives the screen coordinate of the top edge of the property sheet in pixels, relative to the screen origin (upper left).

See also IAgentPropertySheet::GetSize

IAgentPropertySheet::GetSize

HRESULT GetSize(
   long * plWidth,  // address of variable for property sheet width
   long * plHeight  // address of variable for property sheet height
);

Retrieves the size of the Microsoft Agent property sheet window.

Returns S_OK to indicate the operation was successful.

plWidth

Address of a variable that receives the width of the property sheet in pixels, relative to the screen origin (upper left).

plHeight

Address of a variable that receives the height of the property sheet in pixels, relative to the screen origin (upper left).

See also IAgentPropertySheet::GetPosition

IAgentPropertySheet::GetVisible

HRESULT GetVisible(
   long * pbVisible  // address of variable for property sheet
);                   // Visible setting

Determines whether the Microsoft Agent property sheet is visible or hidden.

Returns S_OK to indicate the operation was successful.

pbVisible

Address of a variable that receives TRUE if the property sheet is visible and FALSE if hidden.

See also IAgentPropertySheet::SetVisible

IAgentPropertySheet::SetPage

HRESULT SetPage(
   BSTR bszPage  // current property page
);

Sets the current page of the Microsoft Agent property sheet.

Returns S_OK to indicate the operation was successful.

bszPage

A BSTR that sets the current page of the property. The parameter can be one of the following.

"Speech"	The Speech Recognition page.
"Output"	The Output page.
"Copyright"	The Copyright page.

See also IAgentPropertySheet::GetPage

IAgentPropertySheet::SetVisible

HRESULT SetVisible(
   long bVisible  // property sheet Visible setting 
);

Sets the Visible property for the Microsoft Agent property sheet.

Returns S_OK to indicate the operation was successful.

bVisible

Visible property setting. A value of TRUE displays the property sheet; a value of FALSE hides it.

See also IAgentPropertySheet::GetVisible