UI Customization

The appearance of DocViewer can be manipulated through the interface service calls. The following UI elements can be configured to match the look and feel of your product:

  • AccordionItemBackgroundBrush: Hex color code for accordion item background.
  • AccordionItemExpandedBackgroundBrush: Hex color code for accordion item background when expanded.
  • AccordionItemExpandedForegroundBrush: Hex color code for accordion item foreground when expanded.
  • AccordionItemForegroundBrush: Hex color code for accordion item text.
  • AccordionItemHeaderForegroundBrush: Hex color code for accordion header text.
  • AdditionalXPaths: Any additional xpaths for which to prompt on the Doc Options screen. This option is only used when a list of documents is used for autoselection. If a list of xpaths is provided, the Doc Options screen will display (instead of going straight to the documents) with the specified xpaths available for data entry. Please note that the xpaths will not show up if they are still marked as suppressed in the working dictionary (or overlay dictionary).
  • ButtonBackgroundBrush: Obsolete. Hex color code for the button background.
  • ButtonForegroundBrush: Obsolete. Hex color code for the button text.
  • ButtonMouseOverBackgroundBrush: Obsolete. Hex color code for button background color when the mouse is over.
  • ButtonPrimaryBackground1Brush: Hex color code for the background color of the primary buttons.
  • ButtonPrimaryBackground2Brush: Hex color code for the background color of the primary buttons.
  • ButtonPrimaryBackgroundHover1Brush: Hex color code for the background color of the primary buttons when hovered.
  • ButtonPrimaryBackgroundHover2Brush: Hex color code for the background color of the primary buttons when hovered.
  • ButtonPrimaryBackgroundPress1Brush: Hex color code for the background color of the primary buttons when pressed.
  • ButtonPrimaryBackgroundPress2Brush: Hex color code for the background color of the primary buttons when pressed.
  • ButtonPrimaryTextBrush: Hex color code for the text color of the primary buttons.
  • ButtonPrimaryTextHoverBrush: Hex color code for the text color of the primary buttons when hovered.
  • ButtonPrimaryTextPressBrush: Hex color code for the text color of the primary buttons when pressed.
  • ButtonSecondaryBackgroundPress1Brush: Hex color code for the background color of the secondary buttons when pressed.
  • ButtonSecondaryBackgroundPress2Brush: Hex color code for the background color of the secondary buttons when pressed.
  • ButtonSecondaryBackground1Brush: Hex color code for the background color of the secondary buttons.
  • ButtonSecondaryBackground2Brush: Hex color code for the background color of the secondary buttons.
  • ButtonSecondaryBackgroundHover1Brush: Hex color code for the background color of the secondary buttons when hovered.
  • ButtonSecondaryBackgroundHover2Brush: Hex color code for the background color of the secondary buttons when hovered.
  • ButtonSecondaryBackgroundPress1Brush: Hex color code for the background color of the secondary buttons when pressed.
  • ButtonSecondaryBackgroundPress2Brush: Hex color code for the background color of the secondary buttons when pressed.
  • ButtonSecondaryTextBrush: Hex color code for the text color of the secondary buttons.
  • ButtonSecondaryTextHoverBrush: Hex color code for the text color of the secondary buttons when hovered.
  • ButtonSecondaryTextPressBrush: Hex color code for the text color of the secondary buttons when pressed.
  • ButtonTertiaryBackground1Brush: Hex color code for the background color of the tertiary buttons.
  • ButtonTertiaryBackground2Brush: Hex color code for the background color of the tertiary buttons.
  • ButtonTertiaryBackgroundHover1Brush: Hex color code for the background color of the tertiary buttons when hovered.
  • ButtonTertiaryBackgroundHover2Brush: Hex color code for the background color of the tertiary buttons when hovered.
  • ButtonTertiaryBackgroundPress1Brush: Hex color code for the background color of the tertiary buttons when pressed.
  • ButtonTertiaryBackgroundPress2Brush: Hex color code for the background color of the tertiary buttons when pressed.
  • ButtonTertiaryTextBrush: Hex color code for the text color of the tertiary buttons.
  • ButtonTertiaryTextHoverBrush: Hex color code for the text color of the tertiary buttons when hovered.
  • ButtonTertiaryTextPressBrush: Hex color code for the text color of the tertiary buttons when pressed.
  • ComboBoxBackgroundBrush: Hex color code for combo box background.
  • ComboBoxItemBackgroundBrush: Hex color code for combo box item background.
  • ComboBoxItemForegroundBrush: Hex color code for combo box item foreground.
  • ComboBoxItemHighlightedBackgroundBrush: Hex color code for combo box item background when the item has been selected.
  • ComboBoxItemHighlightedBorderBrush: Hex color code for combo box border when it has focus.
  • ComboBoxItemMouseOverBackgroundBrush: Hex color code for combo box item background when mouse is hovering over.
  • ComboBoxPopupBorderBrush: Hex color code for combo box border when it has focus.
  • DocumentDrawerBackgroundBrush: Hex color code for the doc drawer background.
  • DocumentDrawerDocCountForegroundBrush: Hex color code for the document count text.
  • DocumentDrawerForegroundBrush: Hex color code for the document drawer text.
  • DocumentDrawerItemBackgroundBrush: Hex color code for the document drawer list item background.
  • DocumentDrawerItemForegroundBrush: Hex color code for the document drawer list item text.
  • DocumentDrawerTabForegroundBrush: Hex color code for the document drawer tab text.
  • Extension: The data extension, if any, to apply. Value of "SBA" will apply the SBA Data Collect Extension.
  • FocusBorderBrush: Hex color code for the border hilight color when any non-button control has focus.
  • FocusButtonBorderBrush: Hex color code for the border hilight color when any button control has focus.
  • IsCreateDocumentVisible: makes the Create Documents button visible. This setting allows users to select the documents for which they would like to create a PDF. By default, the IsCreatePDFVisible setting is set to True.
  • IsDocDisplayHeaderVisible - makes the Document Display header visible on the Document Display page.
  • IsDocOptionsHeaderVisible - makes the Document Options header visible on the Document Options page
  • IsDocumentCompletionEnabled: makes the status—Complete/Incomplete visible.
  • IsDocumentDrawerVisible: makes the document drawer visible.
  • IsPackageMenuVisible: makes the packages drop down visible (must be set to true to see the Packages drop down).
  • IsReadOnly: makes DocViewer read only. The only items that can be modified are the Create PDFs checkboxes.
  • IsSummaryTrayVisible: makes the Data Entry portion visible.
  • PageBackgroundBrush: hex color code for the page background
  • SelectedPackage: The package selected. This should only be provided if a list of packages was used for autoselection. This package will be the one selected on the autoselection screen instead of the first one in the list.
  • SmallIconBackgroundFillBrush: Hex color code for background of +, -, and ? icons when they have focus.
  • SummaryTraySliderBrush: Hex color code for left hand slider background.
  • SummaryTraySliderForegroundBrush: Hex color code for left hand slider text.
  • IsBackButtonDisabled - makes the Back button configurable so it does not appear for certain workflows.
  • SupportRequiredData - enables the required field feature in DocViewer and places a red outline around all required fields in a particular document.
  • TextForegroundBrush: Hex color code for general text.
  • TitleTextForegroundBrush: Hex color code for title text.
  • TrackXPathChanges - Instructs DocViewer whether or not to track xpath changes in the transaction and return them in the EndSession/GetSession calls