Focus sur la manipulation des documents

---

Mise à jour : 27 novembre 2024

Export

La méthode TopSolidHost.Documents.Export est utilisée pour exporter un document.

Pour effectuer une exportation, vous devez fournir les éléments suivants : Index de l'exporteur : Un entier représentant l'exporteur désiré (par exemple, Parasolid, Catia, etc.).

• DocumentID : L'identifiant unique du document à exporter. File Path : le chemin où le fichier exporté sera créé.

En fournissant ces paramètres, la méthode facilite l'exportation transparente des documents vers les différents formats pris en charge.

Warning

Évitez de coder en dur l'index d'exportation directement dans le code, car il peut varier en fonction des paramètres d'installation. Pour garantir la fiabilité et l'adaptabilité, il est recommandé d'utiliser une fonction pour récupérer l'index d'exportation de manière dynamique. Pour ce faire, il suffit de fournir l'extension de fichier souhaitée, comme le montre la méthode ci-dessous :

private int GetExporterIndex(string wantedFileExtension)
{
   //Set a default impossible value to the exporter index
   int exporterIndex = -1;
   
   //Browse all exporters to return the index of the PDF one
   for (int i = 0; i < TopSolidHost.Application.ExporterCount; i++)
   {
      string fileType = "";
      string[] fileExtension = null;
      TopSolidHost.Application.GetExporterFileType(i, out fileType, out fileExtension);
      
      //Set the file extension in capital letter to avoid all possible problems
      List<string> extensions = fileExtension.ToList().ConvertAll(d => d.ToUpper()); 
      if (extensions.Contains(wantedFileExtension.ToUpper())
      {
         exporterIndex = i;
         break;
      }
   }
   return exporterIndex;
}

Note

Avant d'exporter un fichier, il est important de vérifier qu'il est exportable en utilisant la méthode TopSolidHost.Documents.CanExport. Si le fichier ne peut pas être exporté, un message d'erreur approprié doit être renvoyé pour informer l'utilisateur.

Importation

La méthode TopSolidHost.Documents.Import est utilisée pour importer un document et fonctionne de la même manière que la méthode Export.

Elle nécessite les entrées suivantes :

• Importer Index : Un entier représentant l'importeur désiré.
• Chemin d'accès au fichier : Le chemin du fichier à importer.
• PdmObjectId : L'identifiant de l'objet dans lequel le fichier doit être importé.

La méthode retourne également deux objets : une liste de révisions et un DocumentId. Bien que ces objets ne soient pas pertinents pour une utilisation de base, ils peuvent s'avérer utiles pour des scénarios d'importation plus avancés.

Warning

Évitez de coder en dur l'index d'importation directement dans le code, car il peut varier en fonction des paramètres d'installation. Pour plus de fiabilité et de sécurité, il est recommandé d'utiliser une fonction pour récupérer dynamiquement l'index d'importation en spécifiant l'extension de fichier souhaitée, comme le montre la méthode ci-dessous :

private int GetImporterIndex(string wantedFileExtension)
{
   //Set a default impossible value to the importer index
   int importerIndex = TopSolidHost.Application.ImporterCount + 1;

   //Browse all importers to return the index of the PDF one
   for (int i = 0; i < TopSolidHost.Application.ImporterCount; i++)
   {
      string fileType = "";
      string[] fileExtension = null;
      TopSolidHost.Application.GetImporterFileType(i, out fileType, out fileExtension);

     //Set the file extension in capital letter to avoid all possible problems
     List<string> extensions = fileExtension.ToList().ConvertAll(d => d.ToUpper()); 
     if (extensions.Contains(wantedFileExtension.ToUpper())
     {
         importerIndex = i;
         break;
     }
   }
   return importerIndex;
}

Utilisation d'un dictionnaire pour les options

Les méthodes TopSolidHost.Documents.ImportWithOptions et TopSolidHost.Documents.ExportWithOptions permettent d'importer ou d'exporter un document avec des options configurables supplémentaires. Pour utiliser ces méthodes, vous devez fournir une liste de paires KeyValue représentant les options en tant que paramètre. Ces options sont spécifiques à l'importeur ou à l'exporteur, en fonction du format de fichier sélectionné.

Vous pouvez récupérer les options disponibles pour un format donné en utilisant les méthodes suivantes :

• TopSolidHost.Application.GetImporterOptions
• TopSolidHost.Application.GetExporterOptions

Important

Exemple : Options pour le format STL

Voici un exemple de liste d'options disponibles pour le format STL :

• SAVE_VERSION
• SIMPLIFY_ASSEMBLY_STRUCTURE
• EXPORTS_RIGID_GROUPS_AS_SUBASSEMBLIES
• LINEAR_TOLERANCE
• ANGULAR_TOLERANCE
• WRITE_MODE
• MAX_FACET_LENGTH
• AGGREGATES_SHAPES
• USER_UNIT_SET
• USER_UNIT
• REPRESENTATION_ID
• REFERENCE_FRAME

Options cachées du dictionnaire

Certaines options plus spécifiques ne seront pas retournées par ces méthodes. Par exemple, pour le format STL :

• CREATION_MODE : les options sont "FacetedShape ","Polyhedron ","PointCloud " ou "SolidShape "

Tip

Pour plus d'informations sur les options disponibles, n'hésitez pas à contacter votre support TopSolid local.