ExportAndCopyPreferences: Set Preferences for Export and Copy

Tag: ExportAndCopyPreferences

The ExportAndCopyPreferences action, along with the applicable SetParam child actions, lets you automate setting the options available in the 'Export & Copy Preferences' dialog found in all FlexyView enabled panels.

Example Script

XML

<ExportAndCopyPreferences>
	<Setparam Field="EXCELUnavailableValueReplacement" Value="EXCELMyUnavailable"/>
	<Setparam Field="EXCELCheckedBoxReplacement" Value="EXCELMyCheck"/>
	<Setparam Field="EXCELUnCheckedBoxReplacement" Value="EXCELMyUnchecked"/>
	<Setparam Field="EXCELHalfCheckedBoxReplacement" Value="EXCELMyHalfchecked"/>
	<Setparam Field="EXCELClickableBoxReplacement" Value="EXCELMyEnabled"/>
	<Setparam Field="EXCELReadOnlyBoxReplacement" Value="EXCELMyDisabled"/>
</ExportAndCopyPreferences>

These settings are "sticky" and will be recorded to the registry.

The Dialog Tabs

Global

HTML

CSV

EXCEL

XML

Rich Text

SetParam Options For Each Dialog Tab

Global Tab

Attribute	Attribute Values	Value Description	Comment
ResetAll	Click	Affirmation that the Param has been activated.	Although the "best practice" would be to enter a value such as "click", this is user definable to any value.

Example Script

XML

<ExportAndCopyPreferences>
	<Setparam Field="ResetAll" Value="Click"/>
</ExportAndCopyPreferences>

HTML Tab

Attribute	Attribute Values	Value Description
HTMLUnavailableValueReplacement	User definable text	Text to be inserted into the cell as a replacement for the type of grid cell indicated - Not Required – current settings will be used if omitted
HTMLCheckBoxReplacement	User definable text	Text to be inserted into the cell as a replacement for the type of grid cell indicated - Not Required – current settings will be used if omitted
HTMLUnCheckedBoxReplacement	User definable text	Text to be inserted into the cell as a replacement for the type of grid cell indicated - Not Required – current settings will be used if omitted
HTMLClickableBoxReplacement	User definable text	Text to be inserted into the cell as a replacement for the type of grid cell indicated - Not Required – current settings will be used if omitted
HTMLReadOnlyBoxReplacement	User definable text	Text to be inserted into the cell as a replacement for the type of grid cell indicated - Not Required – current settings will be used if omitted

Example Script

XML

<ExportAndCopyPreferences>
	<Setparam Field="HTMLUnavailableValueReplacement" Value="HTMLMyUnavailable"/>
	<Setparam Field="HTMLCheckedBoxReplacement" Value="HTMLMyCheck"/>
	<Setparam Field="HTMLUnCheckedBoxReplacement" Value="HTMLMyUnchecked"/>
	<Setparam Field="HTMLHalfCheckedBoxReplacement" Value="HTMLMyHalfchecked"/>
	<Setparam Field="HTMLClickableBoxReplacement" Value="HTMLMyEnabled"/>
	<Setparam Field="HTMLReadOnlyBoxReplacement" Value="HTMLMyDisabled"/>
</ExportAndCopyPreferences>

CSV Tab

Attributes	Attribute Values	Value Description
CSVUnavailableValueReplacement	User definable text	Text to be inserted into the cell as a replacement for the type of grid cell indicated -Not Required – current settings will be used if omitted
CSVCheckedBoxReplacement	User definable text	Text to be inserted into the cell as a replacement for the type of grid cell indicated - Not Required – current settings will be used if omitted
CSVUnCheckedBoxReplacement	User definable text	Text to be inserted into the cell as a replacement for the type of grid cell indicated - Not Required – current settings will be used if omitted
CSVHalfCheckedBoxReplacement	User definable text	Text to be inserted into the cell as a replacement for the type of grid cell indicated - Not Required – current settings will be used if omitted
CSVClickableBoxReplacement	User definable text	Text to be inserted into the cell as a replacement for the type of grid cell indicated - Not Required – current settings will be used if omitted
CSVReadOnlyBoxReplacement	User definable text	Text to be inserted into the cell as a replacement for the type of grid cell indicated - Not Required – current settings will be used if omitted
CSVAdvancedValueDelimiter	User definable text	Text to be used as the value delimiter - Not Required – current settings will be used if omitted
CSVAdvancedDecimalSeparator	User definable text	Text to be used as the decimal separator - Not Required – current settings will be used if omitted
CSVAdvancedLineBreakReplacement	User definable test, exact display text of the dropdown menu item or Index attribute with integer value	N/A - Not Required – current settings will be used if omitted (See detailed description)
CSVAdvancedRowSeparator	User definable test, exact display text of the dropdown menu item or Index attribute with integer value	N/A - Not Required – current settings will be used if omitted (See detailed description)
CSVAdvancedValueSeparator	User definable test, exact display text of the dropdown menu item or Index attribute with integer value	N/A - Not Required – current settings will be used if omitted (See detailed description)
CSVAdvancedValueDelimiterReplacement	User definable text	Text to be inserted into the cell as a replacement for the type of grid cell indicated - Not Required – current settings will be used if omitted
CSVAdvancedAddValueDelimiter	User definable test, exact display text of the dropdown menu item or Index attribute with integer value	N/A - Not Required – current settings will be used if omitted (See detailed description)
CSVAdvancedValueDelimiterClipboard	User definable text	Text to be used as the value delimiter - Not Required – current settings will be used if omitted
CSVAdvancedDecimalSeparatorClipboard	User definable text	Text to be used as the decimal separator - Not Required – current settings will be used if omitted
CSVAdvancedLineBreakReplacementClipboard	User definable test, exact display text of the dropdown menu item or Index attribute with integer value	N/A - Not Required – current settings will be used if omitted (See detailed description)
CSVAdvancedRowSeparatorClipboard	User definable test, exact display text of the dropdown menu item or Index attribute with integer value	N/A - Not Required – current settings will be used if omitted (See detailed description)
CSVAdvancedValueSeparatorClipboard	User definable test, exact display text of the dropdown menu item or Index attribute with integer value	N/A - Not Required – current settings will be used if omitted (See detailed description)
CSVAdvancedValueDelimiterReplacementClipboard	User definable text	Text to be inserted into the cell as a replacement for the value delimiter - Not Required – current settings will be used if omitted
CSVAdvancedAddValueDelimiterClipboard	User definable test, exact display text of the dropdown menu item or Index attribute with integer value	N/A - Not Required – current settings will be used if omitted (See detailed description)

Detailed Description

The options that contain dropdown menu choices can use the Index attribute to select the option within the dropdown list. When using this attribute, 0 = first dropdown item, 1 = second dropdown item, and so on.

Example Script

XML

<ExportAndCopyPreferences>
	<Setparam Field="CSVUnavailableValueReplacement" Value="CSVMyUnavailable"/>
	<Setparam Field="CSVCheckedBoxReplacement" Value="CSVMyCheck"/>
	<Setparam Field="CSVUnCheckedBoxReplacement" Value="CSVMyUnchecked"/>
	<Setparam Field="CSVHalfCheckedBoxReplacement" Value="CSVMyHalfchecked"/>
	<Setparam Field="CSVClickableBoxReplacement" Value="CSVMyEnabled"/>
	<Setparam Field="CSVReadOnlyBoxReplacement" Value="CSVMyDisable
	<Setparam Field="CSVAdvancedValueDelimiter" Value="""/>
	<Setparam Field="CSVAdvancedDecimalSeparator" Value="."/>
	<Setparam Field="CSVAdvancedLineBreakReplacement" Index="1"/>
	<Setparam Field="CSVAdvancedRowSeparator" Value="[New Line]"/>
	<Setparam Field="CSVAdvancedValueSeparator" Value="[Comma]"/>
	<Setparam Field="CSVAdvancedValueDelimiterReplacement" Value=""""/>
	<Setparam Field="CSVAdvancedAddValueDelimiter" Index="
	<Setparam Field="CSVAdvancedValueDelimiterClipboard" Value="'"/>
	<Setparam Field="CSVAdvancedDecimalSeparatorClipboard" Value=","/>
	<Setparam Field="CSVAdvancedLineBreakReplacementClipboard" Value="[Tab]"/>
	<Setparam Field="CSVAdvancedRowSeparatorClipboard" Value="[Line Feed]"/>
	<Setparam Field="CSVAdvancedValueSeparatorClipboard" Value=";"/>
	<Setparam Field="CSVAdvancedValueDelimiterReplacementClipboard" Value="''"/>
	<Setparam Field="CSVAdvancedAddValueDelimiterClipboard" Index="0"/>
</ExportAndCopyPreferences>

EXCEL Tab

Attributes	Attribute Values	Value Description
EXCELUnavailableValueReplacement	User definable text	Text to be inserted into the cell as a replacement for the type of grid cell indicated - Not Required – current settings will be used if omitted
EXCELCheckedBoxReplacement	User definable text	Text to be inserted into the cell as a replacement for the type of grid cell indicated - Not Required – current settings will be used if omitted
EXCELUnCheckedBoxReplacement	User definable text	Text to be inserted into the cell as a replacement for the type of grid cell indicated - Not Required – current settings will be used if omitted
EXCELHalfCheckedBoxReplacement	User definable text	Text to be inserted into the cell as a replacement for the type of grid cell indicated - Not Required – current settings will be used if omitted
EXCELClickableBoxReplacement	User definable text	Text to be inserted into the cell as a replacement for the type of grid cell indicated - Not Required – current settings will be used if omitted
EXCELReadOnlyBoxReplacement	User definable text	Text to be inserted into the cell as a replacement for the type of grid cell indicated - Not Required – current settings will be used if omitted

Example Script

XML

<ExportAndCopyPreferences>
	<Setparam Field="EXCELUnavailableValueReplacement" Value="EXCELMyUnavailable"/>
	<Setparam Field="EXCELCheckedBoxReplacement" Value="EXCELMyCheck"/>
	<Setparam Field="EXCELUnCheckedBoxReplacement" Value="EXCELMyUnchecked"/>
	<Setparam Field="EXCELHalfCheckedBoxReplacement" Value="EXCELMyHalfchecked"/>
	<Setparam Field="EXCELClickableBoxReplacement" Value="EXCELMyEnabled"/>
	<Setparam Field="EXCELReadOnlyBoxReplacement" Value="EXCELMyDisabled"/>
</ExportAndCopyPreferences>

XML Tab

Attributes	Attribute Values	Value Description
XMLUnavailableValueReplacement	User definable text	Text to be inserted into the cell as a replacement for the type of grid cell indicated - Not Required – current settings will be used if omitted
XMLCheckedBoxReplacement	User definable text	Text to be inserted into the cell as a replacement for the type of grid cell indicated - Not Required – current settings will be used if omitted
XMLUnCheckedBoxReplacement	User definable text	Text to be inserted into the cell as a replacement for the type of grid cell indicated - Not Required – current settings will be used if omitted
XMLHalfCheckedBoxReplacement	User definable text	Text to be inserted into the cell as a replacement for the type of grid cell indicated - Not Required – current settings will be used if omitted
XMLClickableBoxReplacement	User definable text	Text to be inserted into the cell as a replacement for the type of grid cell indicated - Not Required – current settings will be used if omitted
XMLReadOnlyBoxReplacement	User definable text	Text to be inserted into the cell as a replacement for the type of grid cell indicated - Not Required – current settings will be used if omitted

Example Script

XML

<ExportAndCopyPreferences>
	<Setparam Field="XMLUnavailableValueReplacement" Value="XMLMyUnavailable"/>
	<Setparam Field="XMLCheckedBoxReplacement" Value="XMLMyCheck"/>
	<Setparam Field="XMLUnCheckedBoxReplacement" Value="XMLMyUnchecked"/>
	<Setparam Field="XMLHalfCheckedBoxReplacement" Value="XMLMyHalfchecked"/>
	<Setparam Field="XMLClickableBoxReplacement" Value="XMLMyEnabled"/>
	<Setparam Field="XMLReadOnlyBoxReplacement" Value="XMLMyDisabled"/>
</ExportAndCopyPreferences>

RichText

Attributes	Attribute Values	Value Description
RTFUnavailableValueReplacement	User definable text	Text to be inserted into the cell as a replacement for the type of grid cell indicated - Not Required – current settings will be used if omitted
RTFCheckedBoxReplacement	User definable text	Text to be inserted into the cell as a replacement for the type of grid cell indicated - Not Required – current settings will be used if omitted
RTFUnCheckedBoxReplacement	User definable text	Text to be inserted into the cell as a replacement for the type of grid cell indicated - Not Required – current settings will be used if omitted
RTFHalfCheckedBoxReplacement	User definable text	Text to be inserted into the cell as a replacement for the type of grid cell indicated - Not Required – current settings will be used if omitted
RTFClickableBoxReplacement	User definable text	Text to be inserted into the cell as a replacement for the type of grid cell indicated - Not Required – current settings will be used if omitted
RTFReadOnlyBoxReplacement	User definable text	Text to be inserted into the cell as a replacement for the type of grid cell indicated - Not Required – current settings will be used if omitted

Example Script

XML

<ExportAndCopyPreferences>
	<Setparam Field="RTFUnavailableValueReplacement" Value="RTFMyUnavailable"/>
	<Setparam Field="RTFCheckedBoxReplacement" Value="RTFMyCheck"/>
	<Setparam Field="RTFUnCheckedBoxReplacement" Value="RTFMyUnchecked"/>
	<Setparam Field="RTFHalfCheckedBoxReplacement" Value="RTFMyHalfchecked"/>
	<Setparam Field="RTFClickableBoxReplacement" Value="RTFMyEnabled"/>
	<Setparam Field="RTFReadOnlyBoxReplacement" Value="RTFMyDisabled"/>
</ExportAndCopyPreferences>