CDocTemplate::GetDocString

Article
03/04/2013

Extrait une chaîne associée au type de document.

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

Paramètres

rString
Une référence à un objet d' CString qui contiendra la chaîne où la fonction retourne.
index
Un index de la sous-chaîne est extraite de la chaîne qui décrit le type de document.Ce paramètre peut prendre l'une des valeurs suivantes :
- Nom deCDocTemplate::windowTitle qui apparaît dans la barre de titre de la fenêtre d'application (par exemple, « Excel »).Entrez uniquement dans le modèle de document pour les applications SDI.
- Racine deCDocTemplate::docName pour le nom de document par défaut (par exemple, « feuille »).Cette racine, plus un nombre, est utilisée pour le nom par défaut d'un document de ce type lorsque l'utilisateur sélectionne la nouvelle commande de menu Fichier (par exemple, « Sheet1 » ou « Sheet2 »).Si elle n'est pas spécifiée, « sans titre » est utilisé comme valeur par défaut.
- Nom deCDocTemplate::fileNewName de ce type de document.Si plusieurs types de prises en charge des applications de document, cette chaîne est affiché dans la boîte de dialogue nouveau fichier (par exemple, « feuille de calcul »).Si elle n'est pas spécifiée, le type de document est inaccessible à l'aide de la nouvelle commande de fichier.
- Description deCDocTemplate::filterName des documents génériques de type de document et d'une correspondance de filtre de ce type.Cette chaîne est affichée dans les Types de fichiers de type liste déroulante dans la boîte de dialogue ouverte de fichier (par exemple, « feuilles de calcul (*.xls) ").Si elle n'est pas spécifiée, le type de document est inaccessible à l'aide de la commande ouverte de fichier.
- Extension deCDocTemplate::filterExt pour les documents de ce type (par exemple, « .xls »).Si elle n'est pas spécifiée, le type de document est inaccessible à l'aide de la commande ouverte de fichier.
- Identificateur deCDocTemplate::regFileTypeId pour le type de document stocké dans la base de données d'inscription mise à jour par windows.Cette chaîne sert à un usage interne uniquement (par exemple, « ExcelWorksheet »).Si elle n'est pas spécifiée, le type de document ne peut pas être enregistré avec le gestionnaire de fichiers windows.
- Nom deCDocTemplate::regFileTypeName du type de document à enregistrer dans la base de données d'inscription.Cette chaîne peut être affichée dans les boîtes de dialogue d'applications qui accèdent à la base de données d'inscription (par exemple, « feuille de calcul Microsoft Excel »).

Valeur de retour

Une valeur différente de zéro si la sous-chaîne spécifiée a été trouvée ; sinon 0.

Notes

Appelez cette fonction pour extraire une sous-chaîne spécifique qui décrivent le type de document.La chaîne contenant les sous-chaînes est stockée dans le modèle de document et est dérivée d'une chaîne dans le fichier de ressources pour l'application.l'infrastructure appelle cette fonction pour obtenir les chaînes qu'elle a besoin pour l'interface utilisateur de l'application.Si vous avez spécifié une extension de nom de fichier pour les documents de votre application, l'infrastructure appelle également la fonction en ajoutant une entrée à la base de données d'inscription Windows ; cela permet aux documents à ouvrir le gestionnaire de fichiers windows.

Appelez cette fonction uniquement si vous dérivez votre propre classe d' CDocTemplate.