CDocTemplate::GetDocString

Artigo
02/25/2013

Recupera uma cadeia de caracteres associada com o tipo de documento.

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

Parâmetros

rString
Uma referência a um objeto de CString que contém a cadeia de caracteres quando a função retornar.
índice
Um índice da subcadeia de caracteres que está sendo recuperada de cadeia de caracteres que descreve o tipo de documento.Este parâmetro pode ter um dos seguintes valores:
- Nome deCDocTemplate::windowTitle que aparece na barra de título da janela do aplicativo (por exemplo, “Microsoft Excel”).Somente presente no modelo do documento para aplicativos de SDI.
- Raiz para o nome padrão do documento (por exemplo, “folha deCDocTemplate::docName ”).Essa raiz, mais um número, é usada para o nome padrão de um novo documento de esse tipo sempre que o usuário escolher o novo comando de menu arquivo (por exemplo, “Sheet1” ou “Sheet2”).Se não for especificado, “entitulado” é usado como o padrão.
- Nome deCDocTemplate::fileNewName de esse tipo de documento.Se o aplicativo suporta mais de um tipo de documento, essa cadeia de caracteres é exibida na caixa de diálogo de Arquivo (por exemplo, “planilha”).Se não for especificado, o tipo de documento é inacessível usando o novo comando de Arquivo.
- A descrição deCDocTemplate::filterName do tipo de documento e uma curinga filtrar documentos compatíveis de esse tipo.Essa cadeia de caracteres é exibida em arquivos de lista na lista suspensa na caixa de diálogo abrir Arquivo (por exemplo, “planilhas (*.xls)").Se não for especificado, o tipo de documento é inacessível usando o comando de Arquivo Aberto.
- Extensão deCDocTemplate::filterExt para documentos de este tipo (por exemplo, “.xls”).Se não for especificado, o tipo de documento é inacessível usando o comando de Arquivo Aberto.
- Identificador deCDocTemplate::regFileTypeId para o tipo de documento é armazenado no banco de dados do registro mantido pelo windows.Essa cadeia de caracteres é somente para uso interno (por exemplo, ExcelWorksheet “”).Se não for especificado, o tipo de documento não pode ser registrado com o gerenciador de arquivos do windows.
- Nome deCDocTemplate::regFileTypeName do tipo de documento para ser armazenado no banco de dados do registro.Essa cadeia de caracteres pode ser exibida nas caixas de diálogo de aplicativos que acessam o banco de dados do registro (por exemplo, “planilha Microsoft Excel”).

Valor de retorno

Diferente de zero se a subcadeia de caracteres especificada foi encontrada; se não 0.

Comentários

Chamar essa função para recuperar uma subcadeia de caracteres específica que descreve o tipo de documento.A cadeia de caracteres que contém as subcadeias de caracteres é armazenada no modelo do documento e derivada de uma cadeia de caracteres no arquivo de recurso para o aplicativo.A estrutura chama essa função para obter as cadeias de caracteres que precisa para a interface do usuário do aplicativo.Se você especificou uma extensão de nome de arquivo para documentos do aplicativo, a estrutura também chama essa função para adicionar uma entrada ao banco de dados de registro do windows; isso permite que todos os documentos abertos do gerenciador de arquivos do windows.

Chamar essa função somente se você estiver criando sua própria classe de CDocTemplate.