DocViewerOptions

Overview

Attribute Description Type/Value
isSummaryTrayVisibile Get/set the visibility of the DATA ENTRY drawer on the left side of the Document Display Page bool? (nullable boolean)
isPackageMenuVisible Get/set the visibility of the package dropdown menu bool? (nullable boolean)
isDocumentDrawerVisible Get/set the visibility of the Documents Drawer at the top of the Document Display Page bool? (nullable boolean)
isDocumentCompletionEnabled Get/set indicator to activate document completion features bool? (nullable boolean)
isCreateDocumentVisible Get/set the visibility of the create document button bool? (nullable boolean)
isCreatePDFVisible Get/set the visibility of the Create PDF checkbox bool? (nullable boolean)
isDocOptionsHeaderVisible Get/set the visibility of the "Doc Options" header bool? (nullable boolean)
isDocDisplayHeaderVisible Get/set the visibility of the Doc Display header bool? (nullable boolean)
isBackButtonDisabled Get/set the visibility of the BACK button in the upper left corner of the Document Display Page bool (non-nullable boolean)
extension The data extension, if any, to apply. Value of "SBA" will apply the SBA Data Collect Extension string
selectedPackage The package selected. This should only be provided if a list of packages was used for autoselection Package{...}
additionalXPaths Any additional xpaths for which to prompt on the Document Options page List<string> ([...])
isReadOnly Get/set indicator to display DocViewer in a read-only state bool? (nullable boolean)
pageBackgroundBrush Hex color code for the page background string
documentDrawerForegroundBrush Hex color code for the Documents Drawer text string
documentDrawerHeaderForegroundBrush Hex color code for the Documents Drawer header text string
documentDrawerDocCountForegroundBrush Hex color code for the Documents Drawer count text string
documentDrawerTabForegroundBrush Hex color code for the Documents Drawer tab text string
documentDrawerBackgroundBrush Hex color code for the doc drawer background string
documentDrawerItemForegroundBrush Hex color code for the Documents Drawer list item text string
documentDrawerItemBackgroundBrush Hex color code for the Documents Drawer list item background string
focusBorderBrush Hex color code for the border highlight color when any non-button control has focus string
focusButtonBorderBrush Hex color code for the border highlight color when any button control has focus string
accordionItemHeaderForegroundBrush Hex color code for accordion header text string
accordionItemBackgroundBrush Hex color code for accordion item background string
accordionItemForegroundBrush Hex color code for accordion item text string
accordionItemExpandedBackgroundBrush Hex color code for accordion item background when expanded string
accordionItemExpandedForegroundBrush Hex color code for accordion item foreground when expanded string
comboBoxBackgroundBrush Hex color code for combo box background string
comboBoxPopupBorderBrush Hex color code for combo box border when it has focus string
comboBoxItemBackgroundBrush Hex color code for combo box item background string
comboBoxItemForegroundBrush Hex color code for combo box item foreground string
comboBoxItemMouseOverBackgroundBrush Hex color code for combo box item background when mouse is hovering over string
comboBoxItemHighlightedBackgroundBrush Hex color code for combo box item background when the item has been selected string
comboBoxItemHighlightedBorderBrush Hex color code for combo box border when it has focus string
textForegroundBrush Hex color code for general text string
titleTextForegroundBrush Hex color code for title text string
summaryTraySliderBrush Hex color code for left hand slider background string
summaryTraySliderForegroundBrush Hex color code for left hand slider text string
smallIconBackgroundFillBrush Hex color code for background of +, -, and ? icons when they have focus string
buttonPrimaryBackground1Brush Hex color code for the background color of the primary buttons string
buttonPrimaryBackground2Brush Hex color code for the background color of the primary buttons string
buttonPrimaryBackgroundHover1Brush Hex color code for the background color of the primary buttons when hovered string
buttonPrimaryBackgroundHover2Brush Hex color code for the background color of the primary buttons when hovered string
buttonPrimaryBackgroundPress1Brush Hex color code for the background color of the primary buttons when pressed string
buttonPrimaryBackgroundPress2Brush Hex color code for the background color of the primary buttons when pressed string
buttonSecondaryBackground1Brush Hex color code for the background color of the secondary buttons string
buttonSecondaryBackground2Brush Hex color code for the background color of the secondary buttons string
buttonSecondaryBackgroundHover1Brush Hex color code for the background color of the secondary buttons when hovered string
buttonSecondaryBackgroundHover2Brush Hex color code for the background color of the secondary buttons when hovered string
buttonSecondaryBackgroundPress1Brush Hex color code for the background color of the secondary buttons when pressed string
buttonSecondaryBackgroundPress2Brush Hex color code for the background color of the secondary buttons when pressed string
buttonTertiaryBackground1Brush Hex color code for the background color of the tertiary buttons string
buttonTertiaryBackground2Brush Hex color code for the background color of the tertiary buttons string
buttonTertiaryBackgroundHover1Brush Hex color code for the background color of the tertiary buttons when hovered string
buttonTertiaryBackgroundHover2Brush Hex color code for the background color of the tertiary buttons when hovered string
buttonTertiaryBackgroundPress1Brush Hex color code for the background color of the tertiary buttons when pressed string
buttonTertiaryBackgroundPress2Brush Hex color code for the background color of the tertiary buttons when pressed string
buttonPrimaryTextBrush Hex color code for the text color of the primary buttons string
buttonPrimaryTextHoverBrush Hex color code for the text color of the primary buttons when hovered string
buttonPrimaryTextPressBrush Hex color code for the text color of the primary buttons when pressed string
buttonSecondaryTextBrush Hex color code for the text color of the secondary buttons string
buttonSecondaryTextHoverBrush Hex color code for the text color of the secondary buttons when hovered string
buttonSecondaryTextPressBrush Hex color code for the text color of the secondary buttons when pressed string
buttonTertiaryTextBrush Hex color code for the text color of the tertiary buttons string
buttonTertiaryTextHoverBrush Hex color code for the text color of the tertiary buttons when hovered string
buttonTertiaryTextPressBrush Hex color code for the text color of the tertiary buttons when pressed string
selectedScreen The screen in DocViewer to initially navigate to DocViewerUI?
selectedDocId The desired Document to initially navigate to string
selectedDocInstanceNumber The instance number of the SelectedDoc to initially navigate to integer($int32)
selectedDocScrollLocation The desired y-axis scroll location within the SelectedDoc to initially navigate to integer($int32)
hideSessionTimeoutErrors Flag to tell DocViewer to not display a session timeout error boolean
trackXPathChanges Flag to tell DocViewer whether or not to track xpath changes in the transaction boolean
supportRequiredData Flag to tell DocViewer whether or not to indicate required fields bool? (nullable boolean)
mergeTransactionWithEmpty Flag to tell DocViewer merge the input txn with the empty transaction in the REQ bool? (nullable boolean)
trackXPathChangesWithIndexAttribute Flag to tell DocViewer whether or not to track xpath changes with index attributes boolean
filterRequiredDocuments Flag to tell DocViewer to default the Required checkbox for filtering documents boolean
filterOptionalDocuments Flag to tell DocViewer to default the Optional checkbox for filtering documents boolean
SaveChangedDataInAzureBlobStorage Flag to indicate whether to save the tracked XPath changes in Azure Blob Storage so they can be recalled if the same LoanIdentifier is used in a future DocViewer Session. boolean
DaysToStoreChangedDataInAzureBlobStorage The number of days to store the data from the "SaveChangedDataInAzureBlobStorage" option integer