OpenXMLWordReport client API - SmartPlant Foundation - IM Update 48 - Help - Hexagon

SmartPlant Foundation Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10
SmartPlant Markup Plus Version
10.0 (2019)
Smart Review Version
2020 (15.0)

The OpenXMLWordReport client API opens a report for a particular type of object using a specified template document.

Argument

Description

Parameter 1

Template Document Name

Parameter 1 description

Name of the template document

Parameter 1 type

String

Parameter 1 default

None

Parameter 2

Truncate Time

Parameter 2 description

This setting controls how dates are displayed in the OpenXML Word report. If set to true, the time format is truncated to show only the date in the OpenXML Word report. If set to false, the full time format is included in the OpenXML Word report.

Parameter 2 type

Boolean

Parameter 2 default

False

Parameter 3

Report Category for Classified objects

Parameter 3 description

This is a value that is used in conjunction with the Report Category property on the template document to make templates available for specific types of objects.

Parameter 3 type

String

Parameter 3 default

None

The following methods use this client API to open delivered reports.

  • DocumentRevisionOpenXMLWordReport

  • ExternalCancelledXmtlOpenXMLWordReport

  • InternalCancelledXmtlOpenXMLWordReport

  • RunExternalXmtlOpenXMLWordReport

  • RunInternaltXmtlOpenXMLWordReport