BravaExtensibleInterface_UserGuide

Brava! ActiveX

Extensible Interface Reference Revision 2.0, Tuesday, July 16, 2013

Table of Contents

Introduction ................................................................................................................................... 4 Product Version Information ............................................................................................................ 4

Personalization (Themes) .............................................................................................................. 5 Theme .......................................................................................................................................... 5

Name ......................................................................................................................................... 5 Schema-Version .......................................................................................................................... 5 Locale ........................................................................................................................................ 5 Created ...................................................................................................................................... 5 Modified ..................................................................................................................................... 6

Regions ......................................................................................................................................... 6 Region .......................................................................................................................................... 6

Name ......................................................................................................................................... 6 Dark .......................................................................................................................................... 7 Foreground ................................................................................................................................. 7

Background-Fill .............................................................................................................................. 7 Value ......................................................................................................................................... 7

Background-Image ......................................................................................................................... 7 Value ......................................................................................................................................... 7

Background-Symbol ....................................................................................................................... 8 Value ......................................................................................................................................... 8

Extensibility (Commands) .............................................................................................................. 9 Extension ...................................................................................................................................... 9

Schema-Version ........................................................................................................................ 10 Locale ...................................................................................................................................... 10 Created .................................................................................................................................... 10 Modified ................................................................................................................................... 10

Controls ...................................................................................................................................... 10 Button ........................................................................................................................................ 10

Xid .......................................................................................................................................... 11 Label ....................................................................................................................................... 11 Tooltip ..................................................................................................................................... 11

Padding....................................................................................................................................... 11 Value ....................................................................................................................................... 11 Top .......................................................................................................................................... 11 Left .......................................................................................................................................... 11 Bottom ..................................................................................................................................... 11 Right ........................................................................................................................................ 11

Image-Dark ................................................................................................................................. 11 Value ....................................................................................................................................... 11

Image-Light................................................................................................................................. 12 Value ....................................................................................................................................... 12

Drop-Down-Button ....................................................................................................................... 12 Drop-Down ............................................................................................................................... 12 Arrow-Direction ......................................................................................................................... 12 Delegate-Xid ............................................................................................................................. 13

Menu .......................................................................................................................................... 13 Xid .......................................................................................................................................... 13

Menu-Text ................................................................................................................................... 13 Xid .......................................................................................................................................... 13 Label ....................................................................................................................................... 13 Image ...................................................................................................................................... 13

Menu-Separator ........................................................................................................................... 14 Layout ........................................................................................................................................ 14 Containers ................................................................................................................................... 14 Container .................................................................................................................................... 14

Name ....................................................................................................................................... 14 Placement-Fixed........................................................................................................................... 15

Xid .......................................................................................................................................... 15 X ............................................................................................................................................. 15 Y ............................................................................................................................................. 15

Placement-Relative ....................................................................................................................... 15 Xid .......................................................................................................................................... 15 Alignment ................................................................................................................................. 15

Placement-Ordered ....................................................................................................................... 16 Xid .......................................................................................................................................... 16 Pivot-Xid .................................................................................................................................. 16 Pre-Order ................................................................................................................................. 16

Text Selection (External Search) .................................................................................................. 17 API ............................................................................................................................................. 17

TextSelectionOptions ................................................................................................................. 17 TextSel_GetPageText ................................................................................................................. 17 TextSel_GetSelection ................................................................................................................. 17 TextSel_SetSelection ................................................................................................................. 18 TextSel_GetTermHits ................................................................................................................. 18 TextSel_SetTermHits ................................................................................................................. 18

Selections ................................................................................................................................... 18 Collation ................................................................................................................................... 19 Default-Color ............................................................................................................................ 19 Schema-Version ........................................................................................................................ 19 Locale ...................................................................................................................................... 19 Created .................................................................................................................................... 19 Modified ................................................................................................................................... 19

Selection ..................................................................................................................................... 19 Color ........................................................................................................................................ 19

Range ......................................................................................................................................... 20 Index ....................................................................................................................................... 20 Len .......................................................................................................................................... 20 Page ........................................................................................................................................ 20

Content ....................................................................................................................................... 20 Usage Notes ................................................................................................................................. 21

Ordered Placements ..................................................................................................................... 21 Appendix A: Identifiers ................................................................................................................ 22

Regions ....................................................................................................................................... 22 Containers ................................................................................................................................... 22 Controls ...................................................................................................................................... 23

Appendix B: Color Specification ................................................................................................... 38 Restricted Color Specification ......................................................................................................... 38 Predefined Color Names ................................................................................................................ 38

Appendix C: Xml Schema Reference ............................................................................................. 42 Themes ....................................................................................................................................... 42

Xml Schema ............................................................................................................................. 42 Example Document .................................................................................................................... 43

Extension .................................................................................................................................... 45 Xml Schema ............................................................................................................................. 45 Example Document .................................................................................................................... 49

Text Selection .............................................................................................................................. 50 Xml Schema ............................................................................................................................. 50 Example Document .................................................................................................................... 51

Introduction

This guide provides a reference for usage of the Brava! ActiveX client extensible interface. This guide is designed for integrators and users who are configuring their implementations to use custom themes. A base knowledge of XML and ActiveX technology is required.

Product Version Information Version 7.2 (Brava! Enterprise, Brava! Enterprise .NET, Brava! Desktop, Brava! Reader, and Free DWG Viewer) Copyright 2013. All rights reserved. If you need information on integrating and customizing Brava Enterprise or if you experience any problems or have general inquiries, please feel free to contact us. IGC

4835 E. Cactus Road, Suite 445

Scottsdale, Arizona 85254

Phone: (602) 971-6061

E-mail: [email protected]

Support: http://www.infograph.com/support/

Web: www.infograph.com

Informative Graphics Corporation July 16, 2013, Revision 2.0 Copyright 2013. All Rights Reserved Page 5

Personalization (Themes)

In BravaX 7.2, color customization (or theme) functionality is provided through the ApplyCustomColor method.

HRESULT ApplyColorCustomization([in] BSTR ColorData, [in] int DataSource);

Parameter Type Notes

ColorData BSTR When DataSource == 1, the argument is interpreted as an Xml-encoded string. When DataSource == 2, the argument is interpreted as a fully-qualified UNC path. In either case, the Xml-encoding is expected to match the Theme schema documented in this section.

DataSource int Indicates the type of the ColorData argument where:

0 FileName

1 String

Theme Themes are used to customize the look of the BravaX control. A Theme is an Xml-encoded, coordinated set of colors and images. The theme element has a name, a version number and locale.

...

Name

The name attribute is used to identify the theme. Alphanumeric characters including spaces are OK. However, characters reserved by the Windows File System should be avoided as the name is also used to identify the theme on disk.

Schema-Version

Version number consists of up-to three digits: major, minor and revision. This version number is used to track changes to the xml schema of Theme documents. This version number is not synchronized with the product version number.

Locale

The locale attribute encodes the language and region that the theme was created in. For BravaX 7.x the only supported locale is en-US.

For additional information on locale names, refer to BCP 47/RFC 4646.

Created

The UTC-encoded date and time that the theme was created. For further information on Universal Coordinated Time i.e. UTC, encoding refer to ISO 8601. All Xml documents created by Brava include the created attribute; however, this attribute is optional and may be omitted by third party Xml authors.


Modified

The date and time that the theme was last written (modified) by the system. All Xml documents created by Brava include the modified attribute; however, this attribute is optional and may be omitted by third party Xml authors.

Regions A Theme consists of a colletion of Regions. A maximum of eleven regions are defined.

...

Region A Region consists of a name, a foreground color and a dark/light indicator.

...

In addition, a Region contains one of three possible background elements:

Element Description

background-fill A single, solid fill color.

background-image An image read from a file or URL.

background-symbol An image stored as an embedded resource with resource identifier N.

A background constructed from an internal resource identifier is depicted below

Name

The region name identifies the area on screen that will be skinned. The regions recognized by the system are:

TaskRegion InformationRegion NavigationRegion ComparisonRegion ScreenBannerRegion ScrollBarRegion PanelRegion PanelTabBackgroundRegion PanelOpenCloseRegion PalletteRegion PalletteSubmenuRegion For additional information, refer to Appendix A: Identifiers Regions.


Dark

The Dark attribute is an image selector hint used by the Brava rendering engine. Valid dark values are:

Value Description

true Dark background

false Light background

Foreground

The Foreground attribute defines the color brush used to paint the region foreground. The foreground attribute is a color specification. For a complete description of color specs see Appendix B: Color Specification.

Background-Fill Defines a background created from a solid fill color.

Value

The value attribute is a hexadecimal ARGB or color name value. For additional information on color specs see Appendix B: Color Specification.

Or...

Background-Image Defines a background created from an image file.

Value

The value attribute is a URL, a fully qualified file name or an expandable file name string containing an environment variable.

Or...

Or...

Note: Images encoded as URLs are retrieved via WinHTTP. Both HTTP and secure, HTTPS, encodings are supported. However, all requests are transmitted under the security context of the Viewers host process. No additional HTTP Client configuration parameters are available at this time.


Background-Symbol Defines a background created from an internal resource identifier.

Value

The value attribute is an internal resource identifier.

Caution: To avoid potential compatibility conflicts with future releases of BravaX, Background-Fill or Background-Image should be favored over Background-Symbol. Support for Background-Symbol may be radically altered or depecrated in a future release.


Extensibility (Commands)

In BravaX 7.x the user interface can be extended by defining custom commands (buttons) in an extension document and calling the following method:

HRESULT ApplyCustomButtons([in] BSTR ButtonData, [in] BOOL IsFile)


ButtonData BSTR When IsFile is TRUE, the argument is interpreted as a fully-qualified UNC path. When IsFile is FALSE, the argument is interpreted as an Xml-encoded string. In either case, the Xml-encoding is expected to match the Extension schema documented in this section.

IsFile BOOL Indicates the type of the ButtonData argument where:

TRUE FileName

FALSE String

The following methods can be used to alter the visibility and enablement of built-in controls as well as the custom commands created via ApplyCustomButtons:

HRESULT DisplayCtrl([in] int ctrlID, [in] BOOL newVal) HRESULT EnableCtrl([in] int ctrlID, [in] BOOL newVal)

Conversely, the following methods can be used to interrogate the state of all controls:

HRESULT CtrlDisplayed([in] int ctrlID, [out, retval] BOOL *pVal) HRESULT CtrlEnabled([in] int ctrlID, [out, retval] BOOL *pVal)

The following method can be used to determine the position of any BravaX control, including custom buttons:

HRESULT GetCtrlScreenCoordinate([in] int CtrlID, [in] int TargetPos, [out, retval] int *Coordinate)

Values for TargetPos are:

Value Description

0 Top

1 Left

2 Right

3 Bottom

Subscribe to the following events to receive notification when a custom button is invoked:

HRESULT CustomButtonInvoked(long ButtonID); HRESULT CustomButtonDropInvoked(long ButtonID);

Extension An Extension document is used to add menu commands to the BravaX control. An extension has a version number and a locale.


created="2010-09-20T20:28:20Z" modified="2010-09-20T20:28:20Z" xmlns="http://schemas.infograph.com/igc-brava-extension.xsd"> ...

Schema-Version

Version number consists of up-to three digits: major, minor and revision. This version number is used to track changes to the xml schema of Extension documents and is not synchronized with the product version number.

Locale



Created

The UTC-encoded date and time that the extension was created. For further information on Universal Coordinated Time i.e. UTC, encoding refer to ISO 8601. All Xml documents created by Brava include the created attribute; however, this attribute is optional and may be omitted by third party Xml authors.

Modified

The date and time that the extension was last written (modified) by the system. All Xml documents created by Brava include the modified attribute; however, this attribute is optional and may be omitted by third party Xml authors.

Controls An extension includes a set of controls.

...

The following control types are supported in this release:

Button Drop-Down-Button Menu

Button A Button is used to launch a programmatic activity. Button attributes include an identifier, label and tool tip.


Xid

All controls are identified by their Xid or external identifier.

Label

The text displayed within the button. To display a graphic button, this attribute may be omitted.

Tooltip

Additional text to be displayed whenever the mouse hovers over the button.

Padding Amount of padding (in pixels) to place around the control.

Note: In this release, the Top and Bottom attributes have no effect on rendering. Left and Right are used to determine the amount of space to place before and after controls. For landscape oriented containers e.g. TaskBar, Left and Right are interpreted literally. For portrait-oriented containers e.g. Pallette, Left determines the space above the control and Right, the space below.

Value

Use this attribute when you want the same amount of padding for all four sides of the control.

Top

The amount of padding above the control.

Left

The amount of padding the left of the control.

Bottom

The amount of padding below the control.

Right

The amount of padding to the right of the control.

Image-Dark The image-dark element is used to specify an external image file. The file name may be expressed as a URL, a fully qualified file name or an expandable file name string.

http://tiny.com/a_l.png Or...

c:\images\a_l.png Or...

%userprofile%\data\a_l.png

Value

Alternatively, the image file can be specified in the value attribute.



Image-Light The image-light element is used to specify an external image file. The file name may be expressed as a URL, a fully qualified file name or an expandable file name string.



%userprofile%\data\a_l.png

Value

Alternatively, the image file can be specified in the value attribute.


Drop-Down-Button Drop-Down Buttons have all the properties of Button including the Padding, Image-Dark, and Image-Light subelements. In addition, Drop-Down-Button defines the Drop-Down, Arrow-Direction and Delegate-Xid attributes.

Drop-Down

Indicates that type of drop-down menu to display. Valid values include:

Value Description

standard An arrow is rendered to the immediate right of the button. This type of button produces a single button invoked event notification.

split The button is split when rendered with a drop-down arrow on the right. This type of button is capable of producing two distinct event notifications, a button invoked event when the body of the button is pressed or a drop-down invoked event when the arrow is pressed.

Arrow-Direction

Determines the orientation of the drop-down arrow.

Value Description

down The drop-down arrow points downward.

right The drop-down arrow points to the right.


Delegate-Xid

The Delegate-Xid attribute designates a Menu or alternate Xid to be executed when the drop-down is activated. This attribute is optional. If specified, the value must be greater than zero. When the drop-down is activated, control is passed to the delegate.

If the delegate is a menu, the menu is displayed. The menu is left-aligned to the lower left corner of the host button. When the user selects an item from the menu, the Xid of the menu item is conveyed via an OnCustomButtonInvoked event notification. If the user elects to dismiss the menu, the system does not produce an event notification.

If the delegate is any other type of control, the Delegate-Xid is conveyed via an OnCustomButtonInvoked event notification.

If the Delegate-Xid attribute is present, the OnCustomDropInvoked event is never raised for this particular drop-down-button. When the drop-down attribute is equal to standard, delegate-xid is ignored.

Menu A menu consists of an Xid and a list of menu items. The following menu items are supported:

Menu-Text Menu-Separator

Xid

All controls are identified by their Xid or external identifier. A menu Xid does not participate in event notifications. A menu can, however, be disabled via CtrlEnabled.

Menu-Text

Xid

All controls are identified by their Xid or external identifier. When a menu item is selected, the Xid is passed as an argument to the notification callback, OnCustomButtonInvoked.

Label

The text displayed for the menu item.

Image

The image element is used to specify an external image file. The image element is optional and if specified, the graphic will be displayed to the left of menu item label. External file names may be expressed as a URL, a fully qualified file name or an expandable file name string.



%userprofile%\data\a_l.png Note: Images encoded as URLs are retrieved via WinHTTP. Both HTTP and secure, HTTPS, encodings are supported. However, all requests are transmitted under the security context of the Viewers host process. No additional HTTP Client configuration parameters are available at this time.


Menu-Separator The menu-separator element is used to place a separator bar between menu items. It has no additional attributes or elements.

Layout An extension also includes a Layout element.

Containers A layout consists of a set of Containers. At present, a maximum of twenty one containers can be defined.

...

Container A Container specifies one of the pre-defined BravaX controls that can be used to host content. Every container has a name.

...

Containers consist of one or more Placement elements. A Placement describes the positioning of a control within a container. There are three distinct placement types.

Element Description

placement-fixed Position the control at a fixed point within the container.

placement-relative The control is positioned relative to the container i.e. aligned left, right or center.

placement-ordered The control is inserted in the display order using another control (termed the pivot) as a reference point.

A single control may appear in one or more containers. Every placement element produces an independent user interface control. Placements based on the same control-id produce identical event notifications.

Name

The container name identifies the control that will host your custom command. The containers recognized by the system are:

TaskBar InformationBar MarkupProperties TextSearch MeasurementResults NavigationBar ComparisonBar ScreenBanner HorizontalScrollBar VerifyPanel ThumbnailPanel


ChangemarkPanel MeasurePanel BookmarkPanel PanelTabBackground PanelOpenCloseBar MarkupTools RedactionTools MeasurementTools TakeoffTools PalletteSubmenu Refer to Appendix A: Identifiers Containers for additional information.

Placement-Fixed The control is displayed at a fixed point within the host container. The point is described in the X and Y attributes of the Placement-Fixed element.

Xid

The external identifier of the control to be placed in this container.

X

The X-axis coordinate relative to the left edge of host container.

Y

The Y-axis coordinate relative to the top edge of the host container.

Placement-Relative The control is rendered relative to the host container using the Alignment attribute.

Xid


Alignment

Determines where the control is rendered in the host container.

Value Description

left Left justify the control within the container. This is the default if no alignment is specified.

center Center the control within the container.

right Right justify the control within the container.


Placement-Ordered Placement is determined by the location of another control in the container. Using the Pivot-Xid attribute, a control can be rendered either before or after the pivot control depending upon whether or not Pre-Order is true or false.

The following restrictions apply when using ordered placement:

The pivot-xid attribute must reference a built-in or user-defined control id. Built-in control ids are listed Appendix A: Identifiers Controls. All user-defined control ids must be defined within the controls element of the extension document.

The pivot-xid attribute must reference a simple control i.e. button, label, combo-box, radio button, check box. Composite and modal controls are not supported. For a complete list of accepted control ids refer to Appendix A: Identifiers Controls. Valid controls are designated as Type = S.

The control referenced by a pivot-xid must reside in the same container. The placement of built-in controls is pre-determined and fixed. User-defined controls can be addressed by placing them within the same container.

A user-defined control must appear in a placement element before it can be used as a pivot-xid. Note that this is a declaration order requirement; not a display order requirement. This restriction is not applicable to built-in controls.

The system does not reject cyclic dependencies in container layouts. The display behavior of layouts containing cyclic depdendencies is undefined.

Xid


Pivot-Xid

The identifier of the control to be used as the pivot control.

Pre-Order

Indicates whether the control should appear before or after the pivot control in the display order.

Value Description

true The control should appear before the pivot control.

false The control should appear after the pivot control.


Text Selection (External Search)

The Text Selection API is introduced in BravaX 7.1 to facilitate automated text selection. External search providers can use this API to retrieve document selections, persist them in external storage and restore them at a later date.

The Text Selection API is comprised of:

A set of coordinated BravaX Viewer methods. Identified by the TextSel_ prefix. A common data exchange format expressed in XML. The same document is used for both input and

output.

API The Text Selection methods are:

HRESULT TextSel_GetPageText([in] int Page, [out,retval] BSTR* Content); HRESULT TextSel_GetSelection([in] int Options, [out,retval] BSTR* TextSelectionXml); HRESULT TextSel_SetSelection([in] BSTR TextSelectionXml); HRESULT TextSel_GetTermHits([in] int Options, [out,retval] BSTR* TextSelectionXml); HRESULT TextSel_SetTermHits([in] BSTR TextSelectionXml);

TextSelectionOptions

TextSelectionOptions is a set of flags used to control the content of the Xml documents exchanged through the API.

Value Symbol Description

0x0001 Color The selection#color attribute should be included in the results.

0x0002 Content The selection/content element should be included in the results.

0x0004 Range The selection/range element should be included in the results.

0x7fff All All properties should be included in the results.

0x8000 PageRange Ranges may be expressed relative to the page or relative to the entire document. Use this option to produce page-relative ranges.

TextSel_GetPageText

This method retrieves the contents of the specified page as a text string. This method can be called repeatedly to retrieve the entire contents of the document.


Page int Indicates the page number to retrieve. The page number must be in the range{1..TotalPages}.

TextSel_GetSelection

This method retrieves the current selection and writes it to a Text Selection Xml document.


Options TextSelectionOptions Flags used to control the composition of the output Xml document.


TextSel_SetSelection

This method is used to select text in the Brava Viewer.


TextSelectionXml String An Xml document containing text selections (as described later in this section). Note that the Content attribute, if present, is ignored.

TextSel_GetTermHits

This method retrieves the term hits currently highlighted in the Brava Viewer and writes them to a Text Selection Xml document.


Options TextSelectionOptions Flags used to control the composition of the output Xml document.

TextSel_SetTermHits

This method is used to highlight term hits in the Brava Viewer.


TextSelectionXml String An Xml document containing text selections (as described later in this section). Note that the Content attribute, if present, is ignored.

Note: If a selection and a term hit overlap onscreen, the highlight will not be visible if the same color is used for both. Selecting a different color for selections and term hits ensures that both will be visible even when they occupy the same text range.

Selections A Selections element contains zero or more Selection elements. The Selections element is comprised of a collation version number, a default color, xml schema version number and locale.

...


Collation

The Collation attribute designates the proprietary IGC text sorting algorithm that produced the indices stored in the Text Selection Xml document.

Caution:If the algorithm used to collate text is changed in a future release of Brava, the API will reject Text Selection documents produced by earlier collation algorithms. As it is not possible to preserve backward-compatibility of the collation algorithm, you must be prepared to recreate the indices under the new collation.

Default-Color

Each Selection may be assigned a Color. If a color has not been explicitly defined for a Selection, the Default-Color is used. This color value is a hexadecimal RGB triplet as described in Restricted Color Specification in Appendix B: Color Specification.

Schema-Version

Version number consists of up-to three digits: major, minor and revision. This version number is used to track changes to the xml schema of Text Selection documents. The schema version is not synchronized with the product version number.

Locale



Created

The UTC-encoded date and time that the extension was created. For further information on Universal Coordinated Time i.e. UTC, encoding refer to ISO 8601. All Xml documents created by Brava include the created attribute; however, this attribute is optional and may be omitted by third party Xml authors.

Modified

The date and time that the extension was last written (modified) by the system. All Xml documents created by Brava include the modified attribute; however, this attribute is optional and may be omitted by third party Xml authors.

Selection A Selection element represents a text selection or text that has been highlighted in the viewer. It is comprised of a text Range element. It may optionally include a Content element.

Now

Color

The Color attribute designates the color used to highlight the text selection in the viewer. It is an optional attribute. If not specified, the Default-Color attribute of the Selections element is used. This color value is a hexadecimal RGB triplet as described in Restricted Color Specification in Appendix B: Color Specification.


Range The Range element represents a location and span of characters within a document. At minimum, it is comprised of an index and length attribute.

This is termed a Document-Scoped Range as the index, or start position, is relative to the beginning of the document.

It is also possible to define a range relative to the page that it appears on. This is termed a Page-Scoped Range.

Only one range type can be in effect within a single Text Selection Xml file. By default, the API reads and writes Document-Scoped Ranges. To use a Page-Scoped Range, pass PageRange in the TextSelectionOptions parameter of TextSel_* method.

Index

The starting position of the text range.

Len

The number of characters in the range.

Page

The source document page number containing the range.

Content The text contained within the associated range. The Content element can be retrieved by passing the Content flag in the TextSelectionOptions parameter when calling TextSel_GetSelection or TextSel_GetTermHits.

This element cannot be used to update document content. If the content element is present when calling TextSel_SetSelection or TextSel_SetTermHits, it is ignored.


Usage Notes

Ordered Placements Using ordered placement can be tricky. Here are a couple of things you can try, if you are not getting the results you expect. The example layouts that follow use the controls defined below.

1. Within a given container, introduce the pivot control before you reference it in another placement. Typically, this is a simple matter of declaring placements in reverse order. In this example, we want to display A B C right aligned within the Information Region.

The following layout Is rewritten as

2. If youre trying to align to a built-in control, make the very first placement an ordered placement with the desired built-in control as the pivot. In this example, we display a simple navigation menu immediately to the left of control 1301 (BXID_TEXT_SEARCH_FIND_COMBO) in the TextSearch container.


Appendix A: Identifiers

Regions

Figure 1. Regions

Containers

Region Container

TaskRegion TaskBar

InformationRegion InformationBar

MarkupProperties

TextSearch

MeasurementResults

NavigationRegion NavigationBar

ComparisonRegion ComparisonBar

TextCompareResizeRegion ComparisonBar

TextCompareHeaderRegion ComparisonBar

ScreenBannerRegion ScreenBanner

ScrollBarRegion HorizontalScrollBar

PanelRegion VerifyPanel


Region Container

ThumbnailPanel

ChangemarkPanel

MeasurePanel

BookmarkPanel

PanelTabBackgroundRegion PanelTabBackground

PanelOpenCloseRegion PanelOpenCloseBar

PalletteRegion MarkupTools

RedactionTools

MeasurementTools

TakeoffTools

PalletteSubmenuRegion PalletteSubmenu

Controls Controls are classified as follows:

[C]omposite Compound controls: Control Containers, Group Boxes. [S]imple Basic controls: Button, Label, ComboBox, RadioButton, CheckBox. [M]odal Controls available in limited contexts: Menus, Menu Items.

Note: Only simple controls can be used in the pivot-xid attribute of an ordered placement element.

ID Symbolic Name Type Description

1 BXID_MAIN_CONTROL C Primary control

TaskBar

100 BXID_TASK_BAR C The top bar containing the main UI controls

101 BXID_TASK_BAR_MARKUP S The task bar's markup button

102 BXID_TASK_BAR_SAVE S The task bar's save button

103 BXID_TASK_BAR_PRINT S The task bar's print button

104 BXID_TASK_BAR_DOC_SELECT S The task bar's document select tool button

105 BXID_TASK_BAR_ANNOTATE S The task bar's annotate button

106 BXID_TASK_BAR_REVIEW S The task bar's review button

107 BXID_TASK_BAR_REDACT S The task bar's redact button

108 BXID_TASK_BAR_MEASURE S The task bar's measure button

109 BXID_TASK_BAR_TAKEOFF S The task bar's takeoff button

110 BXID_TASK_BAR_PUBLISH S The task bar's publish button

111 BXID_TASK_BAR_DOWNLOAD_ORIGINAL S The task bar's download original button

112 BXID_TASK_BAR_MARKETINGMESSAGE S The task bar's marketing message button



113 BXID_MRKEXISTS_PIC S The task bar's markup exists icon

114 BXID_TASK_CUSTOMBOOKMARK S The task bar's custom bookmark button

115 BXID_TASK_BAR_EMCEXIT S The task bar's EMC exit button

PanelOpenCloseBar

200 BXID_PANEL_TOGGLE_BAR C The vertical bar that hides or displays the panel controls

PanelTabBackground

201 BXID_PANEL_CONTAINER C The window that contains the right-side panels

202 BXID_PANEL_CONTAINER_TABS C The tab buttons on the panel container

ThumbnailPanel

300 BXID_THUMBNAIL_PANEL C The thumbnail panel

301 BXID_THUMBNAIL_PANEL_FIRST S The thumbnail panel first page button

302 BXID_THUMBNAIL_PANEL_PREV S The thumbnail panel previous page button

303 BXID_THUMBNAIL_PANEL_NEXT S The thumbnail panel next page button

304 BXID_THUMBNAIL_PANEL_LAST S The thumbnail panel last page button

305 BXID_THUMBNAIL_PANEL_PREV_MRK S The thumbnail panel previous markup page button

306 BXID_THUMBNAIL_PANEL_NEXT_MRK S The thumbnail panel next markup page button

307 BXID_THUMBNAIL_PANEL_THUMBLIST S The thumbnail panel list box full of thumbs

VerifyPanel

400 BXID_VERIFY_PANEL C The verify panel

401 BXID_VERIFY_PANEL_FIRST S The verify panel button to go to the first redaction

402 BXID_VERIFY_PANEL_PREV S The verify panel button to go to the previous redaction

403 BXID_VERIFY_PANEL_NEXT S The verify panel button to go to the next redaction

404 BXID_VERIFY_PANEL_LAST S The verify panel button to go to the last redaction

405 BXID_VERIFY_PANEL_HELP S The verify panel help button

406 BXID_VERIFY_PANEL_FILTER_NONE S The verify panel no filter button

407 BXID_VERIFY_PANEL_FILTER_REASON S The verify panel reason filter button

408 BXID_VERIFY_PANEL_FILTER_REASON_COMBO

S The verify panel reason filter combo

409 BXID_VERIFY_PANEL_FILTER_COLOR S The verify panel color filter button

410 BXID_VERIFY_PANEL_COLOR_SELECT S The verify panel color selection button



411 BXID_VERIFY_PANEL_SEARCH_TARGET S The verify panel dropdown specifying a search target

412 BXID_VERIFY_PANEL_VERIFY_TEXT S The verify panel text "Verify"

413 BXID_VERIFY_PANEL_POSITION_TEXT S The verify panel text showing the current position

414 BXID_VERIFY_PANEL_TEXT_HIDDEN_TEXT S The verify panel text indicating that document text is hidden

415 BXID_VERIFY_PANEL_HORZTOP_SEP S The verify panel top horizontal separator

416 BXID_VERIFY_PANEL_HORZ_SEP S The verify panel horizontal separator

BookmarkPanel

500 BXID_BOOKMARK_PANEL C The bookmark panel

501 BXID_BOOKMARK_PANEL_PREV S The bookmark panel previous bookmark button

502 BXID_BOOKMARK_PANEL_NEXT S The bookmark panel next bookmark button

503 BXID_BOOKMARK_PANEL_HELP S The bookmark panel help button

504 BXID_BOOKMARK_PANEL_SEARCH_BUTTON

S The bookmark panel search button

505 BXID_BOOKMARK_PANEL_SEARCH_COMBO

S The bookmark panel search combo

506 BXID_BOOKMARK_PANEL_SEARCH_SEP S The bookmark panel search separator

507 BXID_BOOKMARK_PANEL_BOOKMARKS S The bookmark panel bookmark display

ChangemarkPanel

600 BXID_CHANGEMARK_PANEL C The changemark panel

601 BXID_CHANGEMARK_PANEL_NEXT S The changemark panel next changemark button

602 BXID_CHANGEMARK_PANEL_PREV S The changemark panel previous changemark button

603 BXID_CHANGEMARK_PANEL_FIND_OPTIONS

S The changemark panel find options button

604 BXID_CHANGEMARK_PANEL_FIND_RESET S The changemark panel find reset button

605 BXID_CHANGEMARK_PANEL_COPY S The changemark panel copy Changemark button

606 BXID_CHANGEMARK_PANEL_HELP S The changemark panel help button

607 BXID_CHANGEMARK_PANEL_HELP_SEP S The changemark panel help separator

608 BXID_CHANGEMARK_PANEL_REPLY S The changemark panel reply button

609 BXID_CHANGEMARK_PANEL_SORT S The changemark panel sort button

610 BXID_CHANGEMARK_PANEL_TITLE_LIST S The changemark panel title list control

611 BXID_CHANGEMARK_PANEL_TEXT S The changemark panel changemark text control



612 BXID_CHANGEMARK_PANEL_FIND S The changemark panel find combo

613 BXID_CHANGEMARK_PANEL_TYPE S The changemark panel changemark type control

614 BXID_CHANGEMARK_PANEL_STATE S The changemark panel changemark state control

MeasurePanel

700 BXID_MEASURE_TAKEOFF_PANEL C The measure take off panel

701 BXID_MEASURE_TAKEOFF_NEW_CATEGORY

S The measure take off new category button

702 BXID_MEASURE_TAKEOFF_EDIT_CATEGORY

S The measure take off edit category button

703 BXID_MEASURE_TAKEOFF_DELETE_CATEGORY

S The measure take off delete category button

704 BXID_MEASURE_TAKEOFF_EXPORT S The measure take off export button

705 BXID_MEASURE_TAKEOFF_CATEGORY_LIST

S The measure take off category list

706 BXID_MEASURE_TAKEOFF_LABEL_TOTAL S The measure take off total label

707 BXID_MEASURE_TAKEOFF_LABEL_TYPE S The measure take off type label

708 BXID_MEASURE_TAKEOFF_EDIT_TOTAL S The measure take off total edit control

709 BXID_MEASURE_TAKEOFF_MESSAGE S The measure take off total message

710 BXID_MEASURE_TAKEOFF_LABEL_SCALE S The measure take off scale label

711 BXID_MEASURE_TAKEOFF_EDIT_SCALE S The measure take off scale edit control

ComparisonBar

800 BXID_COMPARE_BAR C The compare toolbar

801 BXID_COMPARE_BAR_ALIGN S The compare bar align button

802 BXID_COMPARE_BAR_ALIGN_CLEAR S The compare bar clear alignment button

803 BXID_COMPARE_BAR_HELP S The compare bar help button

804 BXID_COMPARE_BAR_OVERLAY S The compare bar overlay button

805 BXID_COMPARE_BAR_OVERLAY_DIFF S The compare bar overlay differences button

806 BXID_COMPARE_BAR_SIDE_BY_SIDE S The compare bar side by side button

807 BXID_COMPARE_BAR_TEXT_COMPARE S The compare bar text compare button

808 BXID_COMPARE_BAR_OPEN_FILE S The compare bar open file button

809 BXID_COMPARE_BAR_COMPARE_FILE S The compare bar compare file button

810 BXID_COMPARE_BAR_ADDITIONS S The compare bar additions button

811 BXID_COMPARE_BAR_DELETIONS S The compare bar deletions button

812 BXID_COMPARE_BAR_UNCHANGED S The compare bar unchanged button

813 BXID_COMPARE_BAR_NUDGE S The compare bar nudge button

814 BXID_COMPARE_BAR_ALIGN_HELP S The compare bar align instructions



815 BXID_COMPARE_BAR_TRANSPARENCY_SLIDER

S The compare bar overlay transparency slider

816 BXID_COMPARE_BAR_REPORT S The compare bar report button

817 BXID_COMPARE_BAR_SETTINGS S The compare bar settings button

[None]

900 BXID_TEXT_COMPARE C The text compare window

901 BXID_TEXT_COMPARE_COMPARISON S The text compare comparison control

902 BXID_TEXT_COMPARE_ARROW_INDICATOR

S The text compare active document arrow indicators

903 BXID_TEXT_COMPARE_OPEN_FILE_TEXT S The text compare text indicating the open document

904 BXID_TEXT_COMPARE_COMPARE_FILE_TEXT

S The text compare text indicating the compare document

905 BXID_TEXT_COMPARE_POSITION_TEXT S The text compare text indicating the current compare position

906 BXID_TEXT_COMPARE_TOP_SEP S The text compare top separator

907 BXID_TEXT_COMPARE_BOTTOM_SEP S The text compare bottom separator

908 BXID_TEXT_COMPARE_NEXT S The text compare next difference button

909 BXID_TEXT_COMPARE_PREV S The text compare previous difference button

NavigationBar

1000 BXID_NAVIGATION_BAR C The bottom navigation bar

1001 BXID_NAV_BAR_PREV_PAGE S The navigation bar previous page button

1002 BXID_NAV_BAR_NEXT_PAGE S The navigation bar next page button

1003 BXID_NAV_BAR_PAGE_COMBO S The navigation bar page combo

1004 BXID_NAV_BAR_ROTATE S The navigation bar rotate button

1005 BXID_NAV_BAR_FITALL S The navigation bar fit all button

1006 BXID_NAV_BAR_FITWIDTH S The navigation bar fit width button

1007 BXID_NAV_BAR_ZOOM_SLIDER S The navigation bar zoom slider

1008 BXID_NAV_BAR_PAN S The navigation bar pan button

1009 BXID_NAV_BAR_ZOOM_RECT S The navigation bar zoom rect tool button

1010 BXID_NAV_BAR_MAGNIFIER S The navigation bar magnifier tool button

1011 BXID_NAV_BAR_BACKGROUND_COLOR S The navigation bar background color button

1012 BXID_NAV_BAR_LAYERS S The navigation bar layers button

HorizontalScrollBar

1100 BXID_HORIZONTAL_SCROLL_BAR C The horizontal scroll bar

[None]



1200 BXID_VERTICAL_SCROLL_BAR C The vertical scroll bar

TextSearch

1300 BXID_TEXT_SEARCH_BAR C The text search control

1301 BXID_TEXT_SEARCH_FIND_COMBO S The text search find combo

1302 BXID_TEXT_SEARCH_FIND_BUTTON S The text search find button

[None]

1400 BXID_FOCUS_INFO_BAR C The focus pane information bar

1401 BXID_FOCUS_INFO_CLOSE S The focus view close button

1402 BXID_FOCUS_INFO_HELP S The focus view help button

1403 BXID_FOCUS_INFO_VIEWED_TEXT S The focus view viewed text label

1404 BXID_FOCUS_INFO_VIEWED_PROGRESS S The focus view viewed progress label

1405 BXID_FOCUS_INFO_PAGE S The focus view page label

1406 BXID_FOCUS_INFO_RESTART S The focus view restart button

1407 BXID_FOCUS_INFO_SIZE S The focus view size button

1408 BXID_FOCUS_SCROLL_BAR S The scroll controls in the focus view

1409 BXID_FOCUS_SCROLL_BAR_PAGE_UP S The focus view page up button

1410 BXID_FOCUS_SCROLL_BAR_UP S The focus view up button

1411 BXID_FOCUS_SCROLL_BAR_DOWN S The focus view down button

1412 BXID_FOCUS_SCROLL_BAR_PAGE_DOWN S The focus view page down button

InformationBar

1500 BXID_INFO_BAR C The toolbar containing the markup properties, measure results, and text find controls

1501 BXID_INFO_BAR_HELP S The help button on the info bar

1502 BXID_INFO_BAR_FILE_DISPLAY_NAME S The filename displayed on the info bar

MeasurementResults

1600 BXID_MEASURE_RESULTS_BAR C The measure results bar

1601 BXID_MEASURE_RESULTS_DISTANCE S The measure take off distance label

1602 BXID_MEASURE_RESULTS_RADIUS S The measure take off radius label

1603 BXID_MEASURE_RESULTS_COUNT S The measure take off count label

1604 BXID_MEASURE_RESULTS_RESULT1 S The measure take off first results text

1605 BXID_MEASURE_RESULTS_RESULT2 S The measure take off second results text

1606 BXID_MEASURE_RESULTS_RESULT3 S The measure take off third results text

1607 BXID_MEASURE_RESULTS_RESULT4 S The measure take off fourth results text

1608 BXID_MEASURE_RESULTS_PERIMETER S The measure take off perimeter label

1609 BXID_MEASURE_RESULTS_TOTAL_DISTAN S The measure take off total distance label



CE

1610 BXID_MEASURE_RESULTS_HEIGHT S The measure take off height label

1611 BXID_MEASURE_RESULTS_CIRCUMFERENCE

S The measure take off circumference label

1612 BXID_MEASURE_RESULTS_ANGLE S The measure take off angle label

1613 BXID_MEASURE_RESULTS_RECT_AREA S The measure take off rectangle area label

1614 BXID_MEASURE_RESULTS_POLY_AREA S The measure take off poly area label

1615 BXID_MEASURE_RESULTS_CIRCLE_AREA S The measure take off circle area label

1616 BXID_MEASURE_RESULTS_REMOVE_LAST_COUNT

S The measure take off remove last count button

1617 BXID_MEASURE_RESULTS_REMOVE_ALL_COUNT

S The measure take off remove all count button

1618 BXID_MEASURE_RESULTS_CURSOR_POS S The measure take off cursor position label

1619 BXID_MEASURE_RESULTS_SNAP S The measure take off snap checkbox

1620 BXID_MEASURE_RESULTS_NEG_AREA S The measure take off negative area checkbox

1621 BXID_MEASURE_RESULTS_SHOW_LEADER S The measure take off show leader checkbox

MarkupProperties

1700 BXID_MARKUP_PROPERTIES_BAR C The bar containing information on markup properties

1701 BXID_MRK_PROP_COLOR S The markup properties color button

1702 BXID_MRK_PROP_FILL S The markup properties fill combo

1703 BXID_MRK_PROP_LINE_WEIGHT S The markup properties line weight combo

1704 BXID_MRK_PROP_LINE_STYLE S The markup properties line style combo

1705 BXID_MRK_PROP_ARROW_HEAD S The markup properties arrow head combo

1706 BXID_MRK_PROP_ARROW_TAIL S The markup properties arrow tail combo

1707 BXID_MRK_PROP_FONT S The markup properties font combo

1708 BXID_MRK_PROP_FONT_SIZE S The markup properties font size combo

1709 BXID_MRK_PROP_STAMP S The markup properties stamp combo

1710 BXID_MRK_PROP_BROWSE_STAMP S The markup properties browse for stamp button

1711 BXID_MRK_PROP_IMAGE S The markup properties image combo

1712 BXID_MRK_PROP_BROWSE_IMAGE S The markup properties browse for image button

1713 BXID_MRK_PROP_TEXT_BACKGROUND S The markup properties text background button

1714 BXID_MRK_PROP_TEXT_UNDERLINE S The markup properties text underline button

1715 BXID_MRK_PROP_TEXT_ITALICS S The markup properties text italics button



1716 BXID_MRK_PROP_TEXT_BOLD S The markup properties text bold button

1717 BXID_MRK_PROP_VARIABLE_TEXT S The markup properties variable text button

1718 BXID_MRK_PROP_HYPERLINK S The markup properties hyperlink button

1719 BXID_MRK_PROP_COPY_TO_PAGES S The markup properties copy to pages button

1720 BXID_MRK_PROP_REDACTION_REASON S The redaction reason combo

1721 BXID_MRK_PROP_REDACTION_REASON_LABEL

S The redaction reason label

MeasurementTools

1800 BXID_MEASURE_TOOLS_BAR C The measure toolbar

1801 BXID_MEASURE_TOOLS_LINE S The measure line tool button

1802 BXID_MEASURE_TOOLS_POLYLINE S The measure polyline tool button

1803 BXID_MEASURE_TOOLS_POLYGON S The measure polygon tool button

1804 BXID_MEASURE_TOOLS_RECTANGLE S The measure rectangle tool button

1805 BXID_MEASURE_TOOLS_CIRCLE S The measure circle tool button

1806 BXID_MEASURE_TOOLS_COUNT S The measure count tool button

MarkupTools

1900 BXID_MARKUP_TOOLS_BAR C The markup toolbar

1901 BXID_MARKUP_TOOLS_POPOUT S The popout menu that appears from the measure toolbar

1902 BXID_MARKUP_TOOLS_SELECT S The markup select tool button

1903 BXID_MARKUP_TOOLS_ARROW_LINE S The markup arrow line tool button

1904 BXID_MARKUP_TOOLS_TEXT S The markup text tool button

1905 BXID_MARKUP_TOOLS_IMAGE S The markup image tool button

1906 BXID_MARKUP_TOOLS_STAMP S The markup stamp tool button

1907 BXID_MARKUP_TOOLS_CLOUD S The markup cloud tool button

1908 BXID_MARKUP_TOOLS_POLYCLOUD S The markup polycloud tool button

1909 BXID_MARKUP_TOOLS_HIGHLIGHT S The markup highlight tool button

1910 BXID_MARKUP_TOOLS_CHANGEMARK S The markup changemark tool button

1911 BXID_MARKUP_TOOLS_HIGHLIGHT_TEXT_CHANGEMARK

S The markup highlight text changemark tool button

1912 BXID_MARKUP_TOOLS_HIGHLIGHT_CHANGEMARK

S The markup highlight changemark tool button

1913 BXID_MARKUP_TOOLS_CLOUD_CHANGEMARK

S The markup cloud changemark tool button

1914 BXID_MARKUP_TOOLS_ARROW_CHANGEMARK

S The markup arrow changemark tool button

1915 BXID_MARKUP_TOOLS_SKETCH S The markup sketch tool button



1916 BXID_MARKUP_TOOLS_SKETCH_POLYGON S The markup sketch polygon tool button

1917 BXID_MARKUP_TOOLS_LINE S The markup line tool button

1918 BXID_MARKUP_TOOLS_POLYLINE S The markup polyline tool button

1919 BXID_MARKUP_TOOLS_ARC S The markup arc tool button

1920 BXID_MARKUP_TOOLS_X_OUT S The markup cross out tool button

1921 BXID_MARKUP_TOOLS_SCRATCH_OUT S The markup scratch out tool button

1922 BXID_MARKUP_TOOLS_ARROW_POINTER S The markup arrow pointer tool button

1923 BXID_MARKUP_TOOLS_RECTANGLE S The markup rectangle tool button

1924 BXID_MARKUP_TOOLS_ROUNDED_RECTANGLE

S The markup rounded rectangle tool button

1925 BXID_MARKUP_TOOLS_POLYGON S The markup polygon tool button

1926 BXID_MARKUP_TOOLS_ELLIPSE S The markup ellipse tool button

1927 BXID_MARKUP_TOOLS_STRIKEOUT S The markup strikeout tool button

1928 BXID_MARKUP_TOOLS_STRIKETHROUGH S The markup strikethrough tool button

1929 BXID_MARKUP_TOOLS_HIGHLIGHT_TEXT S The markup highlight text tool button

1930 BXID_MARKUP_TOOLS_UNDERLINE S The markup underline text tool button

RedactionTools

2000 BXID_REDACTION_TOOLS_BAR C The redaction toolbar

2001 BXID_REDACTION_TOOLS_SELECT S The redaction select tool button

2002 BXID_REDACTION_TOOLS_REDACT S The redact tool button

2003 BXID_REDACTION_TOOLS_REDACT_ALLOW

S The redaction allow area tool button

2004 BXID_REDACTION_TOOLS_PRIVACY S The redact privacy button

2005 BXID_REDACTION_TOOLS_FIND_AND_REDACT

S The find and redact button

2006 BXID_REDACTION_TOOLS_FROM_TO S The redact from - to button

2007 BXID_REDACTION_TOOLS_SCRIPT S The redaction script button

2008 BXID_REDACTION_TOOLS_PAGE S The redact page button

2009 BXID_REDACTION_TOOLS_IMAGE S The redact image button

2010 BXID_REDACTION_TOOLS_TEXT S The redact text button

TakeoffTools

2100 BXID_TAKEOFF_TOOLS_BAR C The measure take off toolbar

2101 BXID_TAKEOFF_TOOLS_SELECT S The take off select button

2102 BXID_TAKEOFF_TOOLS_LINE S The take off line button

2103 BXID_TAKEOFF_TOOLS_POLYLINE S The take off polyline button

2104 BXID_TAKEOFF_TOOLS_POLYGON S The take off polygon button

2105 BXID_TAKEOFF_TOOLS_RECTANGLE S The take off rectangle button



2106 BXID_TAKEOFF_TOOLS_CIRCLE S The take off circle button

2107 BXID_TAKEOFF_TOOLS_COUNT S The take off count button

[None]

2200 BXID_SPLASH_LINK1 S The splash link 1





2205 BXID_SPLASH_PIC S The splash pic

2206 BXID_SPLASH_CLOSE S The close pic

2207 BXID_SPLASH_STRING_VERSION S The version string

2208 BXID_SPLASH_STRING_SKU S The sku string

2209 BXID_SPLASH_STRING_EXPIRATION S The expiration string

2210 BXID_SPLASH_STRING_INTEGRATIONINFO S The integration specific string(bex)

[None]

2300 BXID_DOCUMENT_DRAWING_WND C The main window for rendering drawings and documents

100000 BXID_RIGHT_CLICK_MRK_EDIT_CUT M The markup right-click cut command

100001 BXID_RIGHT_CLICK_MRK_EDIT_COPY M The markup right-click copy command

100002 BXID_RIGHT_CLICK_MRK_EDIT_PASTE M The markup right-click paste command

100003 BXID_RIGHT_CLICK_MRK_EDIT_DELETE M The markup right-click delete command

100004 BXID_RIGHT_CLICK_MRK_EDIT_SELECT_ALL

M The markup right-click select all command

100005 BXID_RIGHT_CLICK_MRK_EDIT_SYM_PLUS_MINUS

M The markup right-click +/- symbol

100006 BXID_RIGHT_CLICK_MRK_EDIT_SYM_DIAMETER

M The markup right-click diameter symbol

100007 BXID_RIGHT_CLICK_MRK_EDIT_SYM_DEGREE

M The markup right-click degree symbol

100008 BXID_RIGHT_CLICK_MRK_EDIT_SYM_COPYRIGHT

M The markup right-click copyright symbol

100009 BXID_RIGHT_CLICK_MRK_EDIT_SYM_REGISTERED

M The markup right-click register symbol

100100 BXID_RIGHT_CLICK_MRK_TEXT_BKGD_TRANSPARENT

M The markup properties right-click text background transparent option

100101 BXID_RIGHT_CLICK_MRK_TEXT_BKGD_OPAQUE

M The markup properties right-click text background opaque option

100102 BXID_RIGHT_CLICK_MRK_TEXT_BKGD_CURRENT

M The markup properties right-click text background current option

100103 BXID_RIGHT_CLICK_MRK_TEXT_BKGD_SE M The markup properties right-click text



LECT background select option

100200 BXID_RIGHT_CLICK_PREV_VIEW M The right-click previous view command

100201 BXID_RIGHT_CLICK_FIT_ALL M The right-click fit all command

100202 BXID_RIGHT_CLICK_FIT_WIDTH M The right-click fit width command

100203 BXID_RIGHT_CLICK_PAN M The right-click pan tool command

100204 BXID_RIGHT_CLICK_COPY M The right-click copy command

100205 BXID_RIGHT_CLICK_PASTE M The right-click paste command

100206 BXID_RIGHT_CLICK_DELETE M The right-click delete command

100207 BXID_RIGHT_CLICK_UNDO M The right-click undo command

100208 BXID_RIGHT_CLICK_REDO M The right-click redo command

100209 BXID_RIGHT_CLICK_COPY_REGION M The right-click copy region command

100210 BXID_RIGHT_CLICK_REDACT_SELECTION M The right-click redact selection command

100300 BXID_RIGHT_CLICK_PAGE_SUBMENU M The right-click page submenu

100301 BXID_RIGHT_CLICK_PAGE_NEXT M The right-click page submenu next page command

100302 BXID_RIGHT_CLICK_PAGE_PREV M The right-click page submenu previous page command

100303 BXID_RIGHT_CLICK_PAGE_FIRST M The right-click page submenu first page command

100304 BXID_RIGHT_CLICK_PAGE_LAST M The right-click page submenu last page command

100305 BXID_RIGHT_CLICK_PAGE_PREV_MRK M The right-click page submenu previous markup page command

100306 BXID_RIGHT_CLICK_PAGE_NEXT_MRK M The right-click page submenu next markup page command

100400 BXID_RIGHT_CLICK_MARKS M The right-click marks submenu

100401 BXID_RIGHT_CLICK_MARKS_ADD_PLACEKEEPER

M The right-click marks submenu add placekeeper command

100402 BXID_RIGHT_CLICK_MARKS_NEXT_PLACEKEEPER

M The right-click marks submenu next placekeeper command

100403 BXID_RIGHT_CLICK_MARKS_PREV_PLACEKEEPER

M The right-click marks submenu previous placekeeper command

100404 BXID_RIGHT_CLICK_MARKS_REMOVE_PLACEKEEPER

M The right-click marks submenu remove all placekeepers command

100405 BXID_RIGHT_CLICK_MARKS_NEXT_BOOKMARK

M The right-click marks submenu next bookmark command

100406 BXID_RIGHT_CLICK_MARKS_PREV_BOOKMARK

M The right-click marks submenu previous bookmark command

100407 BXID_RIGHT_CLICK_MARKS_NEXT_CHANGEMARK

M The right-click marks submenu next changemark command

100408 BXID_RIGHT_CLICK_MARKS_PREV_CHANGEMARK

M The right-click marks submenu previous changemark command



100500 BXID_RIGHT_CLICK_ROTATE M The right-click rotate/mirror submenu

100501 BXID_RIGHT_CLICK_ROTATE_CLOCKWISE M The right-click rotate/mirror submenu rotate clockwise command

100502 BXID_RIGHT_CLICK_ROTATE_COUNTERCLOCKWISE

M The right-click rotate/mirror submenu rotate counterclockwise command

100503 BXID_RIGHT_CLICK_ROTATE_MIRROR M The right-click rotate/mirror submenu mirror command

100600 BXID_RIGHT_CLICK_COLOR M The right-click background color submenu

100601 BXID_RIGHT_CLICK_COLOR_BLACK M The right-click background color submenu black option

100602 BXID_RIGHT_CLICK_COLOR_WHITE M The right-click background color submenu white option

100603 BXID_RIGHT_CLICK_COLOR_GRAY M The right-click background color submenu gray option

100604 BXID_RIGHT_CLICK_COLOR_DEFAULT M The right-click background color submenu default option

100700 BXID_RIGHT_CLICK_OPTIONS M The right-click options submenu

100701 BXID_RIGHT_CLICK_OPTIONS_ANIMATE M The right-click options submenu animate option

100702 BXID_RIGHT_CLICK_OPTIONS_LINE_WEIGHTS

M The right-click options submenu line weights option

100704 BXID_RIGHT_CLICK_OPTIONS_SMOOTH_EDGES

M The right-click options submenu smooth edges option

100800 BXID_RIGHT_CLICK_SHOW_PANE M The right-click show pane submenu

100801 BXID_RIGHT_CLICK_SHOW_PANE_THUMBNAILS

M The right-click show pane submenu thumbnails command

100802 BXID_RIGHT_CLICK_SHOW_PANE_BOOKMARKS

M The right-click show pane submenu bookmarks command

100803 BXID_RIGHT_CLICK_SHOW_PANE_VERIFY M The right-click show pane submenu verify command

100804 BXID_RIGHT_CLICK_SHOW_PANE_CHANGEMARKS

M The right-click show pane submenu Changemark command

100805 BXID_RIGHT_CLICK_SHOW_PANE_MEASURETAKEOFF

M The right-click show pane submenu Changemark command

100900 BXID_VAR_TEXT_MENU_DATE M The variable text menu date option

100901 BXID_VAR_TEXT_MENU_SYSDATE M The variable text menu sys date plus days option

100902 BXID_VAR_TEXT_MENU_TIME M The variable text menu time option

100903 BXID_VAR_TEXT_MENU_MILTIME M The variable text menu military time option

100904 BXID_VAR_TEXT_MENU_TITLE M The variable text menu title option

100905 BXID_VAR_TEXT_MENU_PAGES M The variable text menu pages option

100906 BXID_VAR_TEXT_MENU_TOTAL_PAGES M The variable text menu total pages option



100907 BXID_VAR_TEXT_MENU_BATES_PG_NUM M The variable text menu Bates number option

100908 BXID_VAR_TEXT_MENU_LOGIN M The variable text menu login option

100909 BXID_VAR_TEXT_MENU_USER M The variable text menu user option

100910 BXID_VAR_TEXT_MENU_PROMPT M The variable text menu prompt option

100911 BXID_VAR_TEXT_MENU_DBSTRING M The variable text menu DBString option

100912 BXID_VAR_TEXT_MENU_DBUPDATESTRING M The variable text menu DBUpdateString option

100913 BXID_VAR_TEXT_MENU_PERCENT M The variable text menu % option

100914 BXID_VAR_TEXT_MENU_HOSTNAME M The variable text menu hostname option

100915 BXID_VAR_TEXT_MENU_IPADDRESS M The variable text menu ipaddress option

100916 BXID_VAR_TEXT_MENU_SYM_REGISTERED M The variable text menu registered symbol option

100917 BXID_VAR_TEXT_MENU_SYM_COPYRIGHT M The variable text menu copyright symbol option

101000 BXID_MRK_MENU_NEW M The markup menu new command

101001 BXID_MRK_MENU_OPEN M The markup menu open command

101002 BXID_MRK_MENU_SAVE M The markup menu save command

101003 BXID_MRK_MENU_SAVE_AS M The markup menu save as command

101004 BXID_MRK_MENU_CLOSE M The markup menu close command

101005 BXID_MRK_MENU_CONSOLIDATE M The markup menu consolidate command

101006 BXID_MRK_MENU_NEW_STAMP M The markup menu new stamp template command

101007 BXID_MRK_MENU_OPEN_STAMP M The markup menu open stamp template command

101008 BXID_MRK_MENU_SAVE_STAMP M The markup menu save stamp template command

101009 BXID_MRK_MENU_SAVE_AS_STAMP M The markup menu save as stamp template command

101010 BXID_MRK_MENU_CLOSE_STAMP M The markup menu close stamp template command

101011 BXID_MRK_MENU_SAVE_AS_DXF M The markup menu save as DXF command

101100 BXID_CM_FIND_MENU_CUMULATIVE M The changemark panel find menu cumulative option

101101 BXID_CM_FIND_MENU_WHOLE_WORD M The changemark panel find menu whole word option

101102 BXID_CM_FIND_MENU_MATCH_CASE M The changemark panel find menu match case option

101103 BXID_CM_FIND_MENU_TERM_HIT M The changemark panel find menu term hit option

101200 BXID_CM_SORT_MENU_TITLE M The changemark panel sort menu title option



101201 BXID_CM_SORT_MENU_AUTHOR M The changemark panel sort menu author option

101202 BXID_CM_SORT_MENU_DATE M The changemark panel sort menu date option

101203 BXID_CM_SORT_MENU_TYPE M The changemark panel sort menu type option

101204 BXID_CM_SORT_MENU_STATE M The changemark panel sort menu state option

101205 BXID_CM_SORT_MENU_POSITION M The changemark panel sort menu position option

101300 BXID_COMPARE_MENU_NUDGE_LEFT M The compare toolbar nudge left menu option

101301 BXID_COMPARE_MENU_NUDGE_RIGHT M The compare toolbar nudge right menu option

101302 BXID_COMPARE_MENU_NUDGE_UP M The compare toolbar nudge up menu option

101303 BXID_COMPARE_MENU_NUDGE_DOWN M The compare toolbar nudge down menu option

101400 BXID_FIND_MENU_DOWN M The find menu down option

101401 BXID_FIND_MENU_UP M The find menu up option

101402 BXID_FIND_MENU_MATCH_CASE M The find menu match case option

101403 BXID_FIND_MENU_WHOLE_WORD M The find menu whole word only option

101404 BXID_FIND_MENU_REGEX M The find menu regular expressions option

101405 BXID_FIND_MENU_TERMHIT M The find menu term hit option

101500 BXID_COLOR_MENU_BLACK M The navigation toolbar color menu black option

101501 BXID_COLOR_MENU_WHITE M The navigation toolbar color menu white option

101502 BXID_COLOR_MENU_GRAY M The navigation toolbar color menu gray option

101503 BXID_COLOR_MENU_DEFAULT M The navigation toolbar color menu default option

101504 BXID_COLOR_MENU_MONOCHROME M The navigation toolbar color menu monochrome option

101600 BXID_PRINT_MENU_PRINT M The print menu print option

101601 BXID_PRINT_MENU_PRINT_REGION M The print menu print region option

101602 BXID_PRINT_MENU_BANNERS M The print menu ISO banners option

101700 BXID_REVIEW_MENU_CLOSE M The review menu close review option

101701 BXID_REVIEW_MENU_CM_REVIEW M The review menu changemark review option

101702 BXID_REVIEW_MENU_CM_NEXT M The review menu next changemark option

101703 BXID_REVIEW_MENU_CM_PREV M The review menu prev changemark option



101800 BXID_REDACT_MENU_SAVE M The redact menu publish submenu

101801 BXID_REDACT_MENU_SAVE_PDF M The redact menu publish to PDF option

101802 BXID_REDACT_MENU_SAVE_TIFF M The redact menu publish to TIFF option

101803 BXID_REDACT_MENU_SAVE_DRAFT M The redact menu publish to draft submenu

101804 BXID_REDACT_MENU_SAVE_PDF_DRAFT M The redact menu publish to draft PDF option

101805 BXID_REDACT_MENU_SAVE_TIFF_DRAFT M The redact menu publish to draft TIFF option

101806 BXID_REDACT_MENU_OPEN_TEMPLATE M The redact menu open redactup template option

101807 BXID_REDACT_MENU_RUN_SCRIPT M The redact menu run script option

101808 BXID_REDACT_MENU_VERIFY M The redact menu verify submenu

101809 BXID_REDACT_MENU_VERIFY_REDACTUPS M The redact menu verify submenu redactups option

101810 BXID_REDACT_MENU_VERIFY_IMAGES M The redact menu verify submenu image areas option

101811 BXID_REDACT_MENU_VERIFY_DOCUMENT M The redact menu verify submenu entire document option

101812 BXID_REDACT_MENU_SAVE_CSF M The redact menu publish to CSF

101900 BXID_MEASURE_MENU_TAKEOFF M The measure menu measure/takeoff option

101901 BXID_MEASURE_MENU_CALIBRATE M The measure menu calibrate option

101902 BXID_MEASURE_MENU_SETTINGS M The measure menu settings option

102000 BXID_PUBLISH_MENU_CSF M The publish menu publish to CSF option

102001 BXID_PUBLISH_MENU_DWF M The publish menu publish to DWF option

102002 BXID_PUBLISH_MENU_JPG M The publish menu save as jpg option

102100 BXID_HELP_MENU_CONTENTS M The help menu contents option

102101 BXID_HELP_MENU_ABOUT M The help menu about option

102102 BXID_HELP_MENU_SUGGEST M The help menu suggest new feature option

102200 BXID_THUMBNAIL_MENU_REDUCE M The thumbnail menu option reduce

102201 BXID_THUMBNAIL_MENU_ENLARGE M The thumbnail menu option enlarge

102202 BXID_THUMBNAIL_MENU_DEFAULT M The thumbnail menu option default

102300 BXID_EXTERNAL_BOOKMARK_OPEN M The external bookmark menu option open

102301 BXID_EXTERNAL_BOOKMARK_ADD M The external bookmark menu option add

102302 BXID_EXTERNAL_BOOKMARK_DELETE M The external bookmark menu option delete

[None]

500000 BXID_EXTERNAL_BUTTON_START X Initial offset of externally defined commands


Appendix B: Color Specification

Colorspecs can be encoded as either a hexadecimal ARGB value:

Or, by using one of the predefined color names:

Hexadecimal ARGB values are prefixed by the # symbol. They consist of up to 4 hexadecimal bytes. Channel A is the alpha channel which controls transparency: 0 = transparent, 255 = opaque. Channel R is red, G is green and B is blue per standard RGB notation. At present, the Alpha channel is not interpreted by BravaX.

Channel A R G B Hexadecimal ff 20 80 40 Decimal 255 32 128 64

Hexadecimal ARGB values are read right to left, so that channels may be omitted. The alpha channel defaults to opaque if not specified.

Channel A R G B Hexadecimal ff 0 0 70 Decimal 255 0 0 112

Restricted Color Specification Some components expect a restricted form of color specification. This form omits alpha-channel values and does not support translation of color names. The ARGB quad is reduced to a simple RGB triplet:

All other aspects of the restricted form is identical to the full color specification. In the color reference tables later in this section, simply omit the two alpha-channel digits immediately to the left of the # symbol.

Predefined Color Names The predefined color names are listed in the tables that follow, excerpted from System.Windows.Media Brush Classes.


Figure 2. Color Names Pt. 1 (A-L)


Figure 3. Color Names Pt. 2 (L-Y)


AliceBlue #fff0f8ff

AntiqueWhite #fffaebd7

Aqua #ff00ffff

Aquamarine #ff7fffd4

Azure #fff0ffff

Beige #fff5f5dc

Bisque #ffffe4c4

Black #ff000000

BlanchedAlmond #ffffebcd

Blue #ff0000ff

BlueViolet #ff8a2be2

Brown #ffa52a2a

BurlyWood #ffdeb887

CadetBlue #ff5f9ea0

Chartreuse #ff7fff00

Chocolate #ffd2691e

Coral #ffff7f50

CornflowerBlue #ff6495ed

Cornsilk #fffff8dc

Crimson #ffdc143c

Cyan #ff00ffff

DarkBlue #ff00008b

DarkCyan #ff008b8b

DarkGoldenrod #ffb8860b

DarkGray #ffa9a9a9

DarkGreen #ff006400

DarkKhaki #ffbdb76b

DarkMagenta #ff8b008b

DarkOliveGreen #ff556b2f

DarkOrange #ffff8c00

DarkOrchid #ff9932cc

DarkRed #ff8b0000

DarkSalmon #ffe9967a

DarkSeaGreen #ff8fbc8b

DarkSlateBlue #ff483d8b

DarkSlateGray #ff2f4f4f

DarkTurquoise #ff00ced1

DarkViolet #ff9400d3

DeepPink #ffff1493

DeepSkyBlue #ff00bfff

DimGray #ff696969

DodgerBlue #ff1e90ff

Firebrick #ffb22222

FloralWhite #fffffaf0

ForestGreen #ff228b22

Fuchsia #ffff00ff

Gainsboro #ffdcdcdc

GhostWhite #fff8f8ff

Gold #ffffd700

Goldenrod #ffdaa520

Gray #ff808080

Green #ff008000

GreenYellow #ffadff2f

Honeydew #fff0fff0

HotPink #ffff69b4

IndianRed #ffcd5c5c

Indigo #ff4b0082

Ivory #fffffff0

Khaki #fff0e68c

Lavender #ffe6e6fa

LavenderBlush #fffff0f5

LawnGreen #ff7cfc00

LemonChiffon #fffffacd

LightBlue #ffadd8e6

LightCoral #fff08080

LightCyan #ffe0ffff

LightGoldenrodYellow #fffafad2

LightGray #ffd3d3d3

LightGreen #ff90ee90

LightPink #ffffb6c1

LightSalmon #ffffa07a

LightSeaGreen #ff20b2aa

LightSkyBlue #ff87cefa

LightSlateGray #ff778899

LightSteelBlue #ffb0c4de

LightYellow #ffffffe0

Lime #ff00ff00

LimeGreen #ff32cd32

Linen #fffaf0e6

Magenta #ffff00ff

Maroon #ff800000

MediumAquamarine #ff66cdaa

MediumBlue #ff0000cd

MediumOrchid #ffba55d3

MediumPurple #ff9370db

MediumSeaGreen #ff3cb371

MediumSlateBlue #ff7b68ee

MediumSpringGreen #ff00fa9a

MediumTurquoise #ff48d1cc

MediumVioletRed #ffc71585

MidnightBlue #ff191970

MintCream #fff5fffa

MistyRose #ffffe4e1

Moccasin #ffffe4b5

NavajoWhite #ffffdead

Navy #ff000080

OldLace #fffdf5e6

Olive #ff808000

OliveDrab #ff6b8e23

Orange #ffffa500

OrangeRed #ffff4500

Orchid #ffda70d6

PaleGoldenrod #ffeee8aa

PaleGreen #ff98fb98

PaleTurquoise #ffafeeee

PaleVioletRed #ffdb7093

PapayaWhip #ffffefd5

PeachPuff #ffffdab9

Peru #ffcd853f

Pink #ffffc0cb

Plum #ffdda0dd

PowderBlue #ffb0e0e6

Purple #ff800080

Red #ffff0000

RosyBrown #ffbc8f8f

RoyalBlue #ff4169e1

SaddleBrown #ff8b4513

Salmon #fffa8072

SandyBrown #fff4a460

SeaGreen #ff2e8b57

SeaShell #fffff5ee

Sienna #ffa0522d

Silver #ffc0c0c0

SkyBlue #ff87ceeb

SlateBlue #ff6a5acd

SlateGray #ff708090

Snow #fffffafa

SpringGreen #ff00ff7f

SteelBlue #ff4682b4

Tan #ffd2b48c

Teal #ff008080

Thistle #ffd8bfd8

Tomato #ffff6347

Transparent #00ffffff

Turquoise #ff40e0d0

Violet #ffee82ee

Wheat #fff5deb3

White #ffffffff

WhiteSmoke #fff5f5f5

Yellow #ffffff00

YellowGreen #ff9acd32


Appendix C: Xml Schema Reference

Note: This appendix is provided for informational purposes only. When validating documents, use the latest .XSD available.

Themes

Xml Schema


Example Document

This example, adapted from one of the systems built-in themes, illustrates the various options for encoding the background element.


xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://schemas.infograph.com/igc-brava-theme.xsd" >

Documents

BravaExtensibleInterface_UserGuide