COleLinksDialog Class
Used for the OLE Edit Links dialog box.
Syntax
class COleLinksDialog : public COleDialog
Members
Public Constructors
Name | Description |
---|---|
COleLinksDialog::COleLinksDialog | Constructs a COleLinksDialog object. |
Public Methods
Name | Description |
---|---|
COleLinksDialog::DoModal | Displays the OLE Edit Links dialog box. |
Public Data Members
Name | Description |
---|---|
COleLinksDialog::m_el | A structure of type OLEUIEDITLINKS that controls the behavior of the dialog box. |
Remarks
Create an object of class COleLinksDialog
when you want to call this dialog box. After a COleLinksDialog
object has been constructed, you can use the m_el structure to initialize the values or states of controls in the dialog box. The m_el
structure is of type OLEUIEDITLINKS. For more information about using this dialog class, see the DoModal member function.
Note
Application Wizard-generated container code uses this class.
For more information, see the OLEUIEDITLINKS structure in the Windows SDK.
For more information regarding OLE-specific dialog boxes, see the article Dialog Boxes in OLE.
Inheritance Hierarchy
COleLinksDialog
Requirements
Header: afxodlgs.h
COleLinksDialog::DoModal
Displays the OLE Edit Links dialog box.
virtual INT_PTR DoModal();
Return Value
Completion status for the dialog box. One of the following values:
IDOK if the dialog box was successfully displayed.
IDCANCEL if the user canceled the dialog box.
IDABORT if an error occurred. If IDABORT is returned, call the
COleDialog::GetLastError
member function to get more information about the type of error that occurred. For a listing of possible errors, see the OleUIEditLinks function in the Windows SDK.
Remarks
If you want to initialize the various dialog box controls by setting members of the m_el structure, you should do it before calling DoModal
, but after the dialog object is constructed.
COleLinksDialog::COleLinksDialog
Constructs a COleLinksDialog
object.
COleLinksDialog (
COleDocument* pDoc,
CView* pView,
DWORD dwFlags = 0,
CWnd* pParentWnd = NULL);
Parameters
pDoc
Points to the OLE document that contains the links to be edited.
pView
Points to the current view on pDoc.
dwFlags
Creation flag, which contains either 0 or ELF_SHOWHELP to specify whether the Help button will be displayed when the dialog box is displayed.
pParentWnd
Points to the parent or owner window object (of type CWnd
) to which the dialog object belongs. If it is NULL, the parent window of the dialog box is set to the main application window.
Remarks
This function constructs only a COleLinksDialog
object. To display the dialog box, call the DoModal function.
COleLinksDialog::m_el
Structure of type OLEUIEDITLINKS used to control the behavior of the Edit Links dialog box.
OLEUIEDITLINKS m_el;
Remarks
Members of this structure can be modified either directly or through member functions.
For more information, see the OLEUIEDITLINKS structure in the Windows SDK.