Класс COleChangeSourceDialog

Используется для диалогового окна OLE "Изменить источник".

Синтаксис

class COleChangeSourceDialog : public COleDialog

Участники

Открытые конструкторы

Имя	Описание
COleChangeSourceDialog::COleChangeSourceDialog	Формирует объект COleChangeSourceDialog.

Открытые методы

Имя	Описание
COleChangeSourceDialog::D oModal	Отображает диалоговое окно "Источник изменений OLE".
COleChangeSourceDialog::GetDisplayName	Возвращает полное отображаемое имя источника.
COleChangeSourceDialog::GetFileName	Возвращает имя файла из исходного имени.
COleChangeSourceDialog::GetFromPrefix	Возвращает префикс предыдущего источника.
COleChangeSourceDialog::GetItemName	Возвращает имя элемента из исходного имени.
COleChangeSourceDialog::GetToPrefix	Возвращает префикс нового источника
COleChangeSourceDialog::IsValidSource	Указывает, является ли источник допустимым.

Открытые члены данных

Имя	Описание
COleChangeSourceDialog::m_cs	Структура, управляющая поведением диалогового окна.

Замечания

Создайте объект класса COleChangeSourceDialog при вызове этого диалогового окна. COleChangeSourceDialog После создания объекта можно использовать структуру m_cs для инициализации значений или состояний элементов управления в диалоговом окне. Структура m_cs имеет тип OLEUICHANGESOURCE. Дополнительные сведения об использовании этого класса диалоговых окон см. в функции-члене DoModal .

Дополнительные сведения см . в структуре OLEUICHANGESOURCE в Пакете SDK для Windows.

Дополнительные сведения о диалоговых окнах, относящихся к OLE, см. в статье "Диалоговые окна" в OLE.

Иерархия наследования

CObject

CCmdTarget

CWnd

Cdialog

CCommonDialog

COleDialog

COleChangeSourceDialog

Требования

Заголовок: afxodlgs.h

COleChangeSourceDialog::COleChangeSourceDialog

Эта функция создает COleChangeSourceDialog объект.

explicit COleChangeSourceDialog(
    COleClientItem* pItem,
    CWnd* pParentWnd = NULL);

Параметры

pItem
Указатель на связанный COleClientItem , источник которого необходимо обновить.

pParentWnd
Указывает на родительский или владелец объекта окна (типа CWnd), к которому принадлежит объект диалогового окна. Если значение NULL, родительское окно диалогового окна будет задано в главном окне приложения.

Замечания

Чтобы отобразить диалоговое окно, вызовите функцию DoModal .

Дополнительные сведения см. в статье о структуре OLEUICHANGESOURCE и функции OleUIChangeSource в Windows SDK.

COleChangeSourceDialog::D oModal

Вызовите эту функцию, чтобы отобразить диалоговое окно "Источник изменений OLE".

virtual INT_PTR DoModal();

Возвращаемое значение

Состояние завершения диалогового окна. Одно из следующих значений:

• Идентификатор IDOK, если диалоговое окно было успешно отображено.

• IdCANCEL, если пользователь отменил диалоговое окно.

• IDABORT, если произошла ошибка. Если возвращается IDABORT, вызовите функцию члена COleDialog::GetLastError , чтобы получить дополнительные сведения о типе ошибки, которая произошла. Список возможных ошибок см . в функции OleUIChangeSource в пакете SDK для Windows.

Замечания

Если вы хотите инициализировать различные элементы управления диалоговым окном, задав элементы структуры m_cs , это необходимо сделать перед вызовом DoModal, но после создания объекта диалогового окна.

Если DoModal возвращает идентификатор IDOK, можно вызвать функции-члены для получения введенных пользователем параметров или сведений из диалогового окна. Следующие имена списков типичные функции запроса:

• GetFileName

• GetDisplayName

• GetItemName

COleChangeSourceDialog::GetDisplayName

Вызовите эту функцию, чтобы получить полное отображаемое имя связанного клиентского элемента.

CString GetDisplayName();

Возвращаемое значение

Полное отображаемое имя источника (moniker) для COleClientItem , указанного в конструкторе.

COleChangeSourceDialog::GetFileName

Вызовите эту функцию, чтобы получить моникер файла часть отображаемого имени для связанного клиентского элемента.

CString GetFileName();

Возвращаемое значение

Часть моникера файла исходного отображаемого имени для COleClientItem , указанного в конструкторе.

Замечания

Моникер файла вместе с моникером элемента дает полное отображаемое имя.

COleChangeSourceDialog::GetFromPrefix

Вызовите эту функцию, чтобы получить предыдущую строку префикса для источника.

CString GetFromPrefix();

Возвращаемое значение

Предыдущая строка префикса источника.

Замечания

Вызовите эту функцию только после возврата идентификатора DoModal .

Это значение поступает непосредственно из lpszFrom элемента структуры OLEUICHANGESOURCE .

Дополнительные сведения см . в структуре OLEUICHANGESOURCE в Пакете SDK для Windows.

COleChangeSourceDialog::GetItemName

Вызовите эту функцию, чтобы получить часть моникера элемента отображаемого имени для связанного клиентского элемента.

CString GetItemName();

Возвращаемое значение

Часть моникера элемента исходного отображаемого имени для COleClientItem , указанного в конструкторе.

Замечания

Моникер файла вместе с моникером элемента дает полное отображаемое имя.

COleChangeSourceDialog::GetToPrefix

Вызовите эту функцию, чтобы получить новую строку префикса для источника.

CString GetToPrefix();

Возвращаемое значение

Новая строка префикса источника.

Замечания

Вызовите эту функцию только после возврата идентификатора DoModal .

Это значение поступает непосредственно из lpszTo элемента структуры OLEUICHANGESOURCE .

Дополнительные сведения см . в структуре OLEUICHANGESOURCE в Пакете SDK для Windows.

COleChangeSourceDialog::m_cs

Этот элемент данных представляет собой структуру типа OLEUICHANGESOURCE.

OLEUICHANGESOURCE m_cs;

Замечания

OLEUICHANGESOURCE используется для управления поведением диалогового окна "Источник изменений OLE". Элементы этой структуры можно изменять напрямую.

Дополнительные сведения см . в структуре OLEUICHANGESOURCE в Пакете SDK для Windows.

COleChangeSourceDialog::IsValidSource

Вызовите эту функцию, чтобы определить, является ли новый источник допустимым.

BOOL IsValidSource();

Возвращаемое значение

Ненулевое значение, если новый источник действителен, в противном случае — значение 0.

Замечания

Вызовите эту функцию только после возврата идентификатора DoModal .

Дополнительные сведения см . в структуре OLEUICHANGESOURCE в Пакете SDK для Windows.

См. также

Класс COleDialog
Диаграмма иерархии
Класс COleDialog