| isSummaryTrayVisibile |
Get/set the visibility of the DATA ENTRY drawer on the left side of
the Document Display Page |
bool? (nullable boolean) |
Controls visibility of Datas Entry drawer |
| isPackageMenuVisible |
Get/set the visibility of the package dropdown menu |
bool? (nullable boolean) |
Controls package selection UI |
| isDocumentDrawerVisible |
Get/set the visibility of the Documents Drawer at the top of the
Document Display Page |
bool? (nullable boolean) |
Controls top document navigation |
| isDocumentCompletionEnabled |
Get/set indicator to activate document completion features |
bool? (nullable boolean) |
Feature toggle for document completion |
| isCreateDocumentVisible |
Get/set the visibility of the create document button |
bool? (nullable boolean) |
Controls document creation UI |
| isCreatePDFVisible |
Get/set the visibility of the Create PDF checkbox |
bool? (nullable boolean) |
Controls PDF creation option |
| isDocOptionsHeaderVisible |
Get/set the visibility of the "Doc Options" header |
bool? (nullable boolean) |
HTML DocViewer only |
| isDocDisplayHeaderVisible |
Get/set the visibility of the Doc Display header |
bool? (nullable boolean) |
HTML DocViewer only |
| isBackButtonDisabled |
Get/set the visibility of the BACK button in the upper left corner of
the Document Display Page |
bool (non-nullable boolean) |
Controls navigation back button |
| extension |
The data extension, if any, to apply. Value of "SBA" will apply the
SBA Data Collect Extension |
string |
Can be "SBA" or other extension values |
| selectedPackage |
The package selected. This should only be provided if a list of
packages was used for autoselection |
Package{...} |
This package will be the one selected on the autoselection screen
instead of the first one in the list. |
| additionalXPaths |
Any additional xpaths for which to prompt on the Document Options
page |
List<string> ([...]) |
Used with autoselection of documents |
| isReadOnly |
Get/set indicator to display DocViewer in a read-only state |
bool? (nullable boolean) |
Controls edit permissions |
| pageBackgroundBrush |
Hex color code for the page background |
string |
Color customization |
| documentDrawerForegroundBrush |
Hex color code for the Documents Drawer text |
string |
Color customization |
| documentDrawerHeaderForegroundBrush |
Hex color code for the Documents Drawer header text |
string |
Color customization |
| documentDrawerDocCountForegroundBrush |
Hex color code for the Documents Drawer count text |
string |
Color customization |
| documentDrawerTabForegroundBrush |
Hex color code for the Documents Drawer tab text |
string |
Color customization |
| documentDrawerBackgroundBrush |
Hex color code for the doc drawer background |
string |
Color customization |
| documentDrawerItemForegroundBrush |
Hex color code for the Documents Drawer list item text |
string |
Color customization |
| documentDrawerItemBackgroundBrush |
Hex color code for the Documents Drawer list item background |
string |
Color customization |
| focusBorderBrush |
Hex color code for the border highlight color when any non-button
control has focus |
string |
Color customization |
| focusButtonBorderBrush |
Hex color code for the border highlight color when any button control
has focus |
string |
Color customization |
| accordionItemHeaderForegroundBrush |
Hex color code for accordion header text |
string |
Color customization |
| accordionItemBackgroundBrush |
Hex color code for accordion item background |
string |
Color customization |
| accordionItemForegroundBrush |
Hex color code for accordion item text |
string |
Color customization |
| accordionItemExpandedBackgroundBrush |
Hex color code for accordion item background when expanded |
string |
Color customization |
| accordionItemExpandedForegroundBrush |
Hex color code for accordion item foreground when expanded |
string |
Color customization |
| comboBoxBackgroundBrush |
Hex color code for combo box background |
string |
Color customization |
| comboBoxPopupBorderBrush |
Hex color code for combo box border when it has focus |
string |
Color customization |
| comboBoxItemBackgroundBrush |
Hex color code for combo box item background |
string |
Color customization |
| comboBoxItemForegroundBrush |
Hex color code for combo box item foreground |
string |
Color customization |
| comboBoxItemMouseOverBackgroundBrush |
Hex color code for combo box item background when mouse is hovering
over |
string |
Color customization |
| comboBoxItemHighlightedBackgroundBrush |
Hex color code for combo box item background when the item has been
selected |
string |
Color customization |
| comboBoxItemHighlightedBorderBrush |
Hex color code for combo box border when it has focus |
string |
Color customization |
| textForegroundBrush |
Hex color code for general text |
string |
Color customization |
| titleTextForegroundBrush |
Hex color code for title text |
string |
Color customization |
| summaryTraySliderBrush |
Hex color code for left hand slider background |
string |
Color customization |
| summaryTraySliderForegroundBrush |
Hex color code for left hand slider text |
string |
Color customization |
| smallIconBackgroundFillBrush |
Hex color code for background of +, -, and ? icons when they have
focus |
string |
Color customization |
| buttonPrimaryBackground1Brush |
Hex color code for the background color of the primary
buttons |
string |
Color customization |
| buttonPrimaryBackground2Brush |
Hex color code for the background color of the primary
buttons |
string |
Color customization |
| buttonPrimaryBackgroundHover1Brush |
Hex color code for the background color of the primary buttons when
hovered |
string |
Color customization |
| buttonPrimaryBackgroundHover2Brush |
Hex color code for the background color of the primary buttons when
hovered |
string |
Color customization |
| buttonPrimaryBackgroundPress1Brush |
Hex color code for the background color of the primary buttons when
pressed |
string |
Color customization |
| buttonPrimaryBackgroundPress2Brush |
Hex color code for the background color of the primary buttons when
pressed |
string |
Color customization |
| buttonSecondaryBackground1Brush |
Hex color code for the background color of the secondary
buttons |
string |
Color customization |
| buttonSecondaryBackground2Brush |
Hex color code for the background color of the secondary
buttons |
string |
Color customization |
| buttonSecondaryBackgroundHover1Brush |
Hex color code for the background color of the secondary buttons when
hovered |
string |
Color customization |
| buttonSecondaryBackgroundHover2Brush |
Hex color code for the background color of the secondary buttons when
hovered |
string |
Color customization |
| buttonSecondaryBackgroundPress1Brush |
Hex color code for the background color of the secondary buttons when
pressed |
string |
Color customization |
| buttonSecondaryBackgroundPress2Brush |
Hex color code for the background color of the secondary buttons when
pressed |
string |
Color customization |
| buttonTertiaryBackground1Brush |
Hex color code for the background color of the tertiary
buttons |
string |
Color customization |
| buttonTertiaryBackground2Brush |
Hex color code for the background color of the tertiary
buttons |
string |
Color customization |
| buttonTertiaryBackgroundHover1Brush |
Hex color code for the background color of the tertiary buttons when
hovered |
string |
Color customization |
| buttonTertiaryBackgroundHover2Brush |
Hex color code for the background color of the tertiary buttons when
hovered |
string |
Color customization |
| buttonTertiaryBackgroundPress1Brush |
Hex color code for the background color of the tertiary buttons when
pressed |
string |
Color customization |
| buttonTertiaryBackgroundPress2Brush |
Hex color code for the background color of the tertiary buttons when
pressed |
string |
Color customization |
| buttonPrimaryTextBrush |
Hex color code for the text color of the primary buttons |
string |
Color customization |
| buttonPrimaryTextHoverBrush |
Hex color code for the text color of the primary buttons when
hovered |
string |
Color customization |
| buttonPrimaryTextPressBrush |
Hex color code for the text color of the primary buttons when
pressed |
string |
Color customization |
| buttonSecondaryTextBrush |
Hex color code for the text color of the secondary buttons |
string |
Color customization |
| buttonSecondaryTextHoverBrush |
Hex color code for the text color of the secondary buttons when
hovered |
string |
Color customization |
| buttonSecondaryTextPressBrush |
Hex color code for the text color of the secondary buttons when
pressed |
string |
Color customization |
| buttonTertiaryTextBrush |
Hex color code for the text color of the tertiary buttons |
string |
Color customization |
| buttonTertiaryTextHoverBrush |
Hex color code for the text color of the tertiary buttons when
hovered |
string |
Color customization |
| buttonTertiaryTextPressBrush |
Hex color code for the text color of the tertiary buttons when
pressed |
string |
Color customization |
| selectedScreen |
The screen in DocViewer to initially navigate to |
DocViewerUI? |
Defaults to 'Documents' if SelectedDocId provided |
| selectedDocId |
The desired Document to initially navigate to |
string |
Format: 'PKGD.MyDocument' |
| selectedDocInstanceNumber |
The instance number of the SelectedDoc to initially navigate
to |
integer($int32) |
Defaults to 1 |
| selectedDocScrollLocation |
The desired y-axis scroll location within the SelectedDoc to
initially navigate to |
integer($int32) |
Defaults to 0 |
| hideSessionTimeoutErrors |
Flag to tell DocViewer to not display a session timeout error |
boolean |
Calling app manages timeout |
| trackXPathChanges |
Flag to tell DocViewer whether or not to track xpath changes in the
transaction |
boolean |
Returns changes in EndSession/GetSession |
| supportRequiredData |
Flag to tell DocViewer whether or not to indicate required
fields |
bool? (nullable boolean) |
Feature toggle for required field indication |
| mergeTransactionWithEmpty |
Flag to tell DocViewer merge the input txn with the empty transaction
in the REQ |
bool? (nullable boolean) |
Transaction merge behavior |
| trackXPathChangesWithIndexAttribute |
Flag to tell DocViewer whether or not to track xpath changes with
index attributes |
boolean |
Enhanced xpath change tracking |
| filterRequiredDocuments |
Flag to tell DocViewer to default the Required checkbox for filtering
documents |
boolean |
Default filter setting |
| filterOptionalDocuments |
Flag to tell DocViewer to default the Optional checkbox for filtering
documents |
boolean |
Default filter setting |