# cee::rep::ReportCreatorWord

class `ReportCreatorWord`

  Report creator for a Word report.

  The report creator contains the necessary information and data to create a Word report based on a given template.

  The report creator object must be given a repository and a template file name upon creation. Additional settings such as a reference repository, generic snapshots indices, media type in the generated report and report images quality are also available.

  After applying the necessary settings, the report is created using generate() specifying the path of the generated report.

  For some scenarios it can be convenient to create a report using images instead of 3D models. For instance to compress the file size of the document, if the receiver is not able to install the 3D Plugin or just a report where the plugin’s 3D interaction is not needed. Instead of having to create a new template using images, set setUse3dPlugin(false) and all plugin objects in the template will be replaced with snapshot if these are available within the VTFx file. Default is to use the 3D model for VTFx snapshots.

  The VTFx model file is created in memory and embedded into the Word document. This enables you to easily share your Office document without being afraid of broken links. (The VTFx file will also be embedded into the repository file if this is saved.) If the user does not want to embed the VTFx files into the document, this feature can be turned off with setEmbedVTFx(false). Default is true.

  Generic snapshots will default unroll for all snapshots with matching type in the repository. If only a sub-set of these should be used, you can specify this using setGenericSnapshotIndices().

  See also

  Repository

  Public Functions

  `ReportCreatorWord`(Repository *repository, const Str &templateFile)

    Creates a report creator for a Word document based on the given repository and template file.

  bool `generate`(const Str &reportFile) const

    Generates a report and save it to the file name given by reportFile.

    Returns true if the report was successfully created. Returns false if an error occurred.

  bool `validate`(Str *summary) const

    Validates the current word report template.

    Returns true if document is valid. A summary of the validation is set in the summary parameter.

  void `setReferenceRepository`(Repository *repository)

    Returns the array of indices used for generic snapshots.

  void `setGenericSnapshotIndices`(const std::vector<unsigned int> &indices)

    Sets the array of indices used for generic snapshots.

  void `setEmbedVTFx`(bool embed)

    Sets whether VTFx files should be embedded into the generated report files or not.

  void `setUse3dPlugin`(bool use)

    Sets whether the report should use the 3D plugin/cloud integration.

    Setting use to false will replace all VTFx tagged objects in the template with images.

  Public Static Functions

  static bool `summarize`(const Str &templateFile, Str *summary)

    Validates a word report template.

    Returns true if report template was opened successfully. A summary is set in the summary parameter.

Conversation saved
HOOPSY BETA

### Hello! I'm HOOPSY

Your multilingual generative AI assistant for documentation. Ask me anything about HOOPS Envision for Desktop in your own language, or choose a sample question below to start a conversation:

What is HOOPS Envision for Desktop?
What are the latest release notes for HOOPS Envision for Desktop?
How do I start evaluating HOOPS Envision for Desktop?
How do I write my first sample application?
How can I get assistance?

HOOPSY may store conversations according to OpenAI's policy. Responses may not always be accurate.

HOOPSY is thinking...