CreateListDocumentSnapShot client API - SmartPlant Foundation - IM Update 46 - 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 CreateListDocumentSnapShot client API is used to create a snapshot of a list document.

Argument

Description

Parameter 1

Template Name

Parameter 1 default

None

Parameter 1 description

Identifies the Excel template for the snapshot

Parameter 1 type

String

Parameter 2

Maintain template column size

Parameter 2 default

False

Parameter 2 description

Allows you to configure a specific template with the columns formatted suitably for printing so the list data is only written into the template without template column width modification.

Parameter 2 type

Boolean

Parameter 3

Include column set header

Parameter 3 default

True

Parameter 3 description

Specifies whether or not to include the column set header in the output. The default value is True, meaning the column header from the List Edit control is written in the output. Setting this parameter to False allows you to define a set of column headers that match the widths that you might use if you are using fixed template columns in parameter 2

Parameter 3 type

Boolean

The following methods use the CreateListDocumentSnapShot client API to create snapshots for list documents.

  • CreateListDocumentSnapShot

  • CreateSPFLLADocSnapshot