Methods

The following sections describe the methods available for a Content Manager OnDemand OLE Control.

AboutBox method
The AboutBox method is used to display the About Box.
ActivateFolder method
The ActivateFolder method is used to create active folders.
AnnotateDoc method
The AnnotateDoc method is used to create annotations.
CancelOperation method
The method cancels an operation that was started by a SearchFolder, OpenDoc, or RetrieveDoc method.
ChangePassword method
ClearFolderSearchFields method
This method allows the search fields for the active folder to be cleared.
CloseAllFolders method
The method allows all open folders to be closed.
CloseDoc method
The open document is closed and the control window is repainted with a white background.
CloseFolder method
The active folder is closed.
CopyBitmap method
Copies a selected area of the document to the clipboard in bitmap format.
CopyText method
DeleteDoc method
Content Manager OnDemand deletes the specified document from the database.
FindStringInDoc method
A search is conducted for the text string beginning on the specified page.
GetAnnotationForDoc method
This method is intended for use with Visual Basic.
GetAnnotationStatus method
GetControlId method
The identifier of the control is returned in the specified variable.
GetDocAnnotation method
This method is intended for use with C/C++.
GetDocBackgroundColor method
GetDocCurrentPage method
The current page number of the open document is returned in the specified variable.
GetDocDisplayValue method
This method is intended for use with Visual Basic.
GetDocDisplayValues methods
This method is intended for use with C/C++.
GetDocImageColor method
The current document image color and a changeability indicator are returned.
GetDocImageIntensity methods
GetDocNumPages method
GetDocRotation method
GetDocScrollPositions method
The current scroll positions are returned in the specified variables.
GetDocType method
This method is intended for use with C/C++.
GetDocZoom method
The current, minimum, and maximum zoom percents for the document are returned in the specified variables.
GetFolderDisplayFieldName method
This method is intended for use with Visual Basic.
GetFolderDisplayFieldNames method
This method is intended for use with C/C++.
GetFolderFieldName method
This method is intended for use with Visual Basic.
GetFolderFieldNames method
This method is intended for use with C/C++.
GetFolderName method
This method is intended for use with Visual Basic.
GetFolderNames method
This method is intended for use with C/C++.
GetFolderSearchFieldName method
This method is intended for use with Visual Basic.
GetFolderSearchFieldNames method
This method is intended for use with C/C++.
GetNumDocAnnotations method
The number of annotations attached to the document is returned in the specified variable.
GetNumDocsInList method
The number of documents in the document list of the active folder is returned in the specified variable.
GetNumFolderDisplayFields method
The number of display fields for the active folder is returned in the specified variable.
GetNumFolderFields method
The number of folder fields for the active folder is returned in the specified variable.
GetNumFolders method
The number of folders available for the current server is returned in the specified variable.
GetNumFolderSearchFields method
The number of search fields for the active folder is returned in the specified variable.
GetNumServerPrinters method
The number of server printers available is returned in the specified variable.
GetNumServers method
The number of servers available for logon is returned in the specified variable.
GetServerName method
This method is intended for use with Visual Basic.
GetServerNames method
This method is intended for use with C/C++.
GetServerPrinter method
This method is intended for use with C/C++.
GetServerPrinterInfo method
This method is intended for use with Visual Basic.
GetStoreDocInvalidFieldNum method
The field number returned is the zero-based index of the folder field which caused the problem. If a previous StoreDoc method did not return one of the listed codes, the value received is unpredictable.
GetTypeForDoc method
Retrieves the document type.
IsDocHorzScrollRequired method
If the width of the document data exceeds the width of the control window, the result variable is set to a nonzero value; otherwise, to zero.
Logoff method
Logs off from the current server.
Logon method
If each of pServerName, pUserId, and pPassword are non-NULL and point to a string other than an empty string, a logon is performed with the specified data.
OnSysColorChange method
Colors used for Content Manager OnDemand dialog boxes are updated to the current system colors. This method intended for use with C/C++.
OpenDoc method
The document associated with the specified index in the document list of the active folder of the specified Content Manager OnDemand OLE Control is opened and displayed in the window of this control.
OpenFolder method
If pFolderName is non-NULL and points to a string other than an empty string, the named folder is opened.
PrintDoc method
The page of the specified document is printed.
RetrieveDoc method
The data for the indicated document and its associated resource group, if any, are retrieved from the Content Manager OnDemand database and written to the indicated files.
ScrollDocHorz method
The document data is horizontally scrolled as indicated by Type and the current scroll position is returned in the variable pointed to by pPosition.
ScrollDocVert method
The document data is vertically scrolled as indicated by Type and the current scroll position is returned in the variable pointed to by pPosition.
SearchFolder method
The active folder is searched with the current field values. These values were set by default, by the user, or by the SetFolderSearchFieldData method.
SetDefaultFolderSearchFields method
The search fields for the active folder are set to their default values.
SetDocBackgroundColor method
The document is displayed with the new background color.
SetDocCurrentPage method
The current page number of the open document is set to the specified page and the control window is repainted with the data for that page.
SetDocImageColor method
The document is displayed with the new image color.
SetDocImageIntensity method
The document is displayed with the new image intensity.
SetDocRotation method
The document is displayed at the new rotation.
SetDocZoom method
The document is displayed at the new zoom percent and the new scroll positions are returned in the specified variables.
SetFolderCloseMemoryRelease method
Determines whether memory is to be released when a folder is closed. By default, the setting is false.
SetFolderSearchFieldData method
The search operator and values are set for the specified field for the active folder.
SetLogonReturnOnFailure method
Determines the action to be taken when a logon fails. By default, the setting is false.
SetResourceCacheMode method
The requested mode is set.
SetRightButtonMenu method
Creates a menu to be displayed when the user clicks the right mouse button in the document window.
SetSelectionMode method
Subsequent mouse selection by the user is performed in the specified mode.
SetServerPrinterData method
The data associated with each index defaults to the empty string. Any data set using this method is retained until changed.
SetUserMessageMode method
Subsequent Content Manager OnDemand exception messages resulting from OLE Control operations are displayed or suppressed as requested.
ShowFolder method
The Content Manager OnDemand Folder dialog box is displayed or hidden.
ShowWaitCursorDuringCancelableOperation method
During cancelable operations, Content Manager OnDemand normally displays a wait cursor.
StoreDoc method
Content Manager OnDemand converts the folder field values to application group fields and stores the data from the specified file in the database as a document associated with the specified application group and application.
UndoFind method
Highlighting is removed from the current found string.
UpdateDoc method
Content Manager OnDemand converts the folder field value to an application group field and updates the data from the specified value in the database.
WasOperationCancelled method
If the most recent SearchFolder, OpenDoc, or RetrieveDoc operation was cancelled, the result variable is set to a nonzero value; otherwise, to zero.