Share via


CDocTemplate::GetDocString

Recupera una cadena asociado al tipo de documento.

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

Parámetros

  • rString
    Una referencia a un objeto de CString que contendrá la cadena cuando finaliza la función.

  • índice
    Un índice de la subcadena que se recupera de la cadena que describe el tipo de documento.Este parámetro puede tener uno de los valores siguientes:

    • Nombre deCDocTemplate::windowTitle que aparece en la barra de título de la ventana de la aplicación (por ejemplo, “Microsoft Excel”).Muestra sólo en la plantilla del documento para las aplicaciones SDI.

    • Raíz para el nombre del documento predeterminado (por ejemplo, “hoja” deCDocTemplate::docName ).Esta raíz, más un número, se usa para el nombre predeterminado de un nuevo documento de este tipo siempre que el usuario elija el comando de Nuevo desde el menú archivo (por ejemplo, “Sheet1” o “Sheet2”).Si no se especifica, “sin título” se utiliza como valor predeterminado.

    • Nombre deCDocTemplate::fileNewName de este tipo de documento.Si la aplicación admite más de un tipo de documento, esta cadena se muestra en el cuadro de diálogo de Archivo Nuevo (por ejemplo, “hoja de cálculo”).Si no se especifica, el tipo de documento es inaccesible utilizando el comando de Archivo Nuevo.

    • La descripción deCDocTemplate::filterName de tipo de documento y un comodín se filtran documentos que coinciden en este tipo.Esta cadena se muestra en los archivos de lista de la lista desplegable escrita en el cuadro de diálogo Abrir archivo (por ejemplo, “hojas de cálculo (*.xls) ").Si no se especifica, el tipo de documento es inaccesible mediante el comando para Abrir archivos.

    • Extensión deCDocTemplate::filterExt para los documentos de este tipo (por ejemplo, “.xls”).Si no se especifica, el tipo de documento es inaccesible mediante el comando para Abrir archivos.

    • Identificador deCDocTemplate::regFileTypeId para que el tipo de documento está almacenado en la base de datos de registro mantenida por Windows.Esta cadena es sólo para uso interno (por ejemplo, “ExcelWorksheet”).Si no se especifica, el tipo de documento no se puede registrar con el administrador de archivos de Windows.

    • Nombre deCDocTemplate::regFileTypeName de tipo de documento que se va a almacenar en la base de datos de registro.Esta cadena se puede mostrar en cuadros de diálogo de aplicaciones que tienen acceso a la base de datos del registro (por ejemplo, “hoja de cálculo de Microsoft Excel”).

Valor devuelto

Distinto de cero si la subcadena especificada se encontró; si no 0.

Comentarios

Llame a esta función para recuperar una subcadena específica que describe el tipo de documento.Cadena que contiene estas subcadenas se almacena en la plantilla de documento y es derivada de una cadena en el archivo de recursos para la aplicación.El marco de trabajo llama a esta función para obtener las cadenas que necesita para la interfaz de usuario de la aplicación.Si ha especificado una extensión de nombre de archivo para los documentos de la aplicación, el marco también llama a esta función cuando agregue una entrada a la base de datos del registro de Windows; esto permite que los documentos están abiertos del administrador de archivos de Windows.

Llame a esta función sólo si es derivar poseer la clase de CDocTemplate.

Requisitos

encabezado: afxwin.h

Vea también

Referencia

Clase CDocTemplate

Gráfico de jerarquía

CMultiDocTemplate::CMultiDocTemplate

CSingleDocTemplate::CSingleDocTemplate

CWinApp::RegisterShellFileTypes