CDocTemplate::GetDocString

Статья
02/20/2013

Извлекает строку, связанную с типом документа.

virtual BOOL GetDocString(
   CString& rString,
   enum DocStringIndex index 
) const;

Параметры

rString
Ссылка на объект CString, который будет содержать строку, если функция возвратит.
индекс
Индекс подстроки, полученной из строки, описывающий тип документа.Этот параметр может принимать одно из следующих значений:
- Имя CDocTemplate::windowTitle, отображаемый в заголовке окна приложения (например, "Microsoft Excel").Представьте только в шаблоне документа для приложений SDI.
- Корень имени документа по умолчанию (например, "лист"CDocTemplate::docName ).Этот корень, а также номер, используемый для имени по умолчанию нового документа этого типа, когда пользователь выбирает новой команды из меню "Файл" (например "Лист1, Лист2" или "").Если не указан, "без заголовка" используется в качестве значения по умолчанию.
- Имя CDocTemplate::fileNewName этого типа документа.Если приложение поддерживает несколько типов документов, то эта строка выводится в диалоговом окне файла новом (например, "листе").Если не указан тип документа недоступен, используя команду файла новую.
- Описание CDocTemplate::filterName типа документа и подстановочный знак фильтрации совпадающих документы данного типа.Эта строка выводится в файлах списка раскрывающегося списка тип в диалоговом окне открытие файла (например, "листах (*.xls) ").Если не указан тип документа недоступен с помощью команды открыть файл.
- Расширение CDocTemplate::filterExt для документов этого типа (например, ".xls").Если не указан тип документа недоступен с помощью команды открыть файл.
- Идентификатор CDocTemplate::regFileTypeId для типа документа, который будет храниться в базе данных регистрации поддерживаемой Windows.Эта строка для внутреннего пользования (например, "ExcelWorksheet").Если не указан тип документа не могут быть зарегистрированы с файловыми менеджером Windows.
- Имя CDocTemplate::regFileTypeName типа документа, который будет храниться в базе данных регистрации.Эта строка может отображаться в диалоговых окнах приложений, получающих доступ к базе данных регистрации (например, "лист Microsoft Excel").

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

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

Заметки

Эта функция вызывается для получения определенной подстрока, описывающий тип документа.Строка, содержащая эти функции substring хранится в шаблоне документа и наследуется из строки в файле ресурсов приложения.Платформа вызывает функцию эту функцию для получения строки для данного для пользовательского интерфейса приложения.Если расширение имени файла для документов приложения, то платформа также эта функция вызывается при добавлении записи в базе данных регистрации Windows; это позволяет документы, который требуется открыть из файлового менеджера Windows.

Эта функция вызывается только при наследовании собственный класс, производный от CDocTemplate.