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........................................................................................................................................ 8
Foreground............................................................................................................................... 8
Background-Fill............................................................................................................................8
Value....................................................................................................................................... 8
Background-Image.......................................................................................................................8
Value....................................................................................................................................... 8
Background-Symbol......................................................................................................................9
Value....................................................................................................................................... 9
Extensibility (Commands)..........................................................................................................10
Extension.................................................................................................................................. 10
Schema-Version.......................................................................................................................11
Locale.................................................................................................................................... 11
Created.................................................................................................................................. 11
Modified................................................................................................................................. 11
Controls.................................................................................................................................... 11
Button...................................................................................................................................... 11
Xid......................................................................................................................................... 12
Label...................................................................................................................................... 12
Tooltip.................................................................................................................................... 12
Padding..................................................................................................................................... 12
Value..................................................................................................................................... 12
Top........................................................................................................................................ 12
Left........................................................................................................................................ 12
Bottom................................................................................................................................... 12
Right...................................................................................................................................... 12
Image-Dark............................................................................................................................... 12
Value..................................................................................................................................... 12
Image-Light............................................................................................................................... 13
Value..................................................................................................................................... 13
Drop-Down-Button......................................................................................................................13
Drop-Down............................................................................................................................. 13
Arrow-Direction.......................................................................................................................13
Delegate-Xid...........................................................................................................................14
Menu........................................................................................................................................ 14
Xid......................................................................................................................................... 14
Menu-Text................................................................................................................................. 14
Xid......................................................................................................................................... 14
Label...................................................................................................................................... 14
Image.................................................................................................................................... 14
Menu-Separator.........................................................................................................................15
Layout...................................................................................................................................... 15
Containers................................................................................................................................. 15
Container.................................................................................................................................. 15
Name..................................................................................................................................... 15
Placement-Fixed.........................................................................................................................16
Xid......................................................................................................................................... 16
X........................................................................................................................................... 16
Y........................................................................................................................................... 16
Placement-Relative.....................................................................................................................16
Xid......................................................................................................................................... 16
Alignment............................................................................................................................... 16
Placement-Ordered.....................................................................................................................17
Xid......................................................................................................................................... 17
Pivot-Xid................................................................................................................................. 17
Pre-Order............................................................................................................................... 17
Text Selection (External Search)................................................................................................18
API........................................................................................................................................... 18
TextSelectionOptions................................................................................................................18
TextSel_GetPageText................................................................................................................18
TextSel_GetSelection................................................................................................................18
TextSel_SetSelection................................................................................................................18
TextSel_GetTermHits................................................................................................................19
TextSel_SetTermHits................................................................................................................19
Selections.................................................................................................................................. 19
Collation................................................................................................................................. 19
Default-Color...........................................................................................................................20
Schema-Version.......................................................................................................................20
Locale.................................................................................................................................... 20
Created.................................................................................................................................. 20
Modified................................................................................................................................. 20
Selection................................................................................................................................... 20
Color...................................................................................................................................... 20
Range....................................................................................................................................... 20
Index..................................................................................................................................... 21
Len........................................................................................................................................ 21
Page...................................................................................................................................... 21
Content..................................................................................................................................... 21
Usage Notes............................................................................................................................... 22
Ordered Placements....................................................................................................................22
Appendix A: Identifiers..............................................................................................................23
Regions..................................................................................................................................... 23
Containers................................................................................................................................. 23
Controls.................................................................................................................................... 24
Appendix B: Color Specification..................................................................................................39
Restricted Color Specification........................................................................................................39
Predefined Color Names...............................................................................................................39
Appendix C: Xml Schema Reference...........................................................................................43
Themes..................................................................................................................................... 43
Xml Schema............................................................................................................................43
Example Document..................................................................................................................44
Extension.................................................................................................................................. 46
Xml Schema............................................................................................................................46
Text Selection............................................................................................................................51
Xml Schema............................................................................................................................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: info@infograph.com
Support: http://www.infograph.com/support/
Web: www.infograph.com
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.
<?xml version="1.0" encoding="utf-8"?>

<theme
name="Black"
schema-version="7.0.0"
locale="en-US"
created="2010-09-08T18:06:53Z"
modified="2010-09-08T18:06:53Z"
xmlns="http://schemas.infograph.com/igc-brava-theme.xsd">
...
</theme>
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.
Informative Graphics Corporation

Copyright 2013. All Rights Reserved
July 16, 2013, Revision 2.0

Page 5
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.
<theme ...>
<regions>
...
</regions>
</theme>
Region
A Region consists of a name, a foreground color and a dark/light indicator.
<region name="CompareRegion" dark="true" foreground="#ffffffff">

...
</region>
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
<region name="TaskRegion" dark="true" value="#ffffffff">

<background-symbol value="2907"/>
</region>
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

Page 6
For additional information, refer to Appendix A: Identifiers Regions.


Page 7
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.
<background-fill value="#ffffffff" />

Or...
<background-fill value="White" />
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.
<background-image value="http://tiny.com/a.png" />

Or...
<background-image value="c:\images\a.png" />

Or...
<background-image value="%userprofile%\data\a.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.


Page 8
Background-Symbol
Defines a background created from an internal resource identifier.
Value
The value attribute is an internal resource identifier.
<background-symbol value="2907" />

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.


Page 9
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)

Parameter
Type
Notes
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
Top
Left
Right
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.
<?xml version="1.0" encoding="UTF-8"?>

<extension

Page 10
locale="en-US"
created="2010-09-20T20:28:20Z"
modified="2010-09-20T20:28:20Z"
xmlns="http://schemas.infograph.com/igc-brava-extension.xsd">
...
</extension>
Schema-Version
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
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.
<extension ...>
<controls>
...
</controls>
</extension>
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.
<button xid="500003" drop-down="split" direction="down" label="Apply"

tooltip="Apply Markup">
<padding value="1"/>
</button>


Page 11
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.
<image-dark>http://tiny.com/a_l.png</image-dark>
Or...
<image-dark>c:\images\a_l.png</image-dark>
Or...
<image-dark>%userprofile%\data\a_l.png</image-dark>
Value
Alternatively, the image file can be specified in the value attribute.
<image-dark value="http://tiny.com/a.png" />


Page 12
Image-Light
The image-light element is used to specify an external image file. The file name may be expressed as a URL,
<image-light>http://tiny.com/a_l.png</image-light>
Or...
<image-light>c:\images\a_l.png</image-light>
Or...
<image-light>%userprofile%\data\a_l.png</image-light>
Value
Alternatively, the image file can be specified in the value attribute.
<image-light value="http://tiny.com/a_l.png" />

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.


Page 13
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,
<image>http://tiny.com/a_l.png</image>
Or...
<image>c:\images\a_l.png</image>
Or...
<image>%userprofile%\data\a_l.png</image>


Page 14
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.
<layout>
<containers>
...
</containers>
</layout>
Container
A Container specifies one of the pre-defined BravaX controls that can be used to host content. Every
container has a name.
<container name="CompareBar">
...
</container>
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

Page 15
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.


Page 16
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.


Page 17
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
HRESULT
HRESULT
HRESULT
HRESULT
TextSel_GetPageText([in] int Page, [out,retval] BSTR* Content);

TextSel_GetSelection([in] int Options, [out,retval] BSTR* TextSelectionXml);
TextSel_SetSelection([in] BSTR TextSelectionXml);
TextSel_GetTermHits([in] int Options, [out,retval] BSTR* TextSelectionXml);
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.
Parameter
Type
Notes
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.
Parameter
Type
Notes
Options
Flags used to control the composition of the output Xml document.
TextSel_SetSelection
This method is used to select text in the Brava Viewer.

Page 18
Parameter
Type
Notes
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.
Parameter
Type
Notes
Options
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.
Parameter
Type
Notes
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.

<selections
collation="4.0.0"
default-color="#000000"
locale="en-US"
created="2011-08-31T18:56:30.769Z"
modified="2011-08-31T18:56:30.769Z"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="http://schemas.infograph.com/igc-cdl-text-selection.xsd"
>
...
</selections>
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

Page 19
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
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
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.
<selection color="#ffff00">
<range index="126" len="3" page="19" />
<content>Now</content>
</selection>
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.
<range index="1747" len="3" />

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

Page 20
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.


Page 21
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.
<controls>

<button xid="500000"

</controls>
1.
label="A" tooltip="Alpha"/>
label="B" tooltip="Beta"/>
label="C" tooltip="Gamma"/>
label="F"
label="P"
label="N"
label="L"
tooltip="First"/>
tooltip="Previous"/>
tooltip="Next"/>
tooltip="Last"/>
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
<layout>
<container name="InformationBar">
<placement-ordered xid="500000" pivot-xid="500001" pre-order="true"/>
<placement-relative xid="500002" alignment="right"/>
</container>
</layout>
Is rewritten as
<layout>
</container>
</layout>
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.
<layout>
<container name="TextSearch">
<placement-ordered xid="500815"
</container>
</layout>

pivot-xid="1301" pre-order="true"/>

Page 22
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


Page 23
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
BXID_MAIN_CONTROL
Primary control
100
BXID_TASK_BAR
The top bar containing the main UI

controls
101
BXID_TASK_BAR_MARKUP
The task bar's markup button
102
BXID_TASK_BAR_SAVE
The task bar's save button
103
BXID_TASK_BAR_PRINT
The task bar's print button
104
BXID_TASK_BAR_DOC_SELECT
The task bar's document select tool

button
105
BXID_TASK_BAR_ANNOTATE
The task bar's annotate button
106
BXID_TASK_BAR_REVIEW
The task bar's review button
107
BXID_TASK_BAR_REDACT
The task bar's redact button
108
BXID_TASK_BAR_MEASURE
The task bar's measure button
109
BXID_TASK_BAR_TAKEOFF
The task bar's takeoff button
110
BXID_TASK_BAR_PUBLISH
The task bar's publish button
111
BXID_TASK_BAR_DOWNLOAD_ORIGINAL
The task bar's download original button
112
BXID_TASK_BAR_MARKETINGMESSAGE
The task bar's marketing message button
TaskBar


Page 24
ID
Symbolic Name
Type
Description
113
BXID_MRKEXISTS_PIC
The task bar's markup exists icon
114
BXID_TASK_CUSTOMBOOKMARK
The task bar's custom bookmark button
115
BXID_TASK_BAR_EMCEXIT
The task bar's EMC exit button
The vertical bar that hides or displays the

panel controls
PanelOpenCloseBar
200
BXID_PANEL_TOGGLE_BAR
PanelTabBackground
201
BXID_PANEL_CONTAINER
The window that contains the right-side

panels
202
BXID_PANEL_CONTAINER_TABS
The tab buttons on the panel container
ThumbnailPanel
300
BXID_THUMBNAIL_PANEL
The thumbnail panel
301
BXID_THUMBNAIL_PANEL_FIRST
The thumbnail panel first page button
302
BXID_THUMBNAIL_PANEL_PREV
The thumbnail panel previous page button
303
BXID_THUMBNAIL_PANEL_NEXT
The thumbnail panel next page button
304
BXID_THUMBNAIL_PANEL_LAST
The thumbnail panel last page button
305
BXID_THUMBNAIL_PANEL_PREV_MRK
The thumbnail panel previous markup

page button
306
BXID_THUMBNAIL_PANEL_NEXT_MRK
The thumbnail panel next markup page

button
307
BXID_THUMBNAIL_PANEL_THUMBLIST
The thumbnail panel list box full of

thumbs
400
BXID_VERIFY_PANEL
The verify panel
401
BXID_VERIFY_PANEL_FIRST
The verify panel button to go to the first

redaction
402
BXID_VERIFY_PANEL_PREV
The verify panel button to go to the

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

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

redaction
405
BXID_VERIFY_PANEL_HELP
The verify panel help button
406
BXID_VERIFY_PANEL_FILTER_NONE
The verify panel no filter button
407
BXID_VERIFY_PANEL_FILTER_REASON
The verify panel reason filter button
408
BXID_VERIFY_PANEL_FILTER_REASON_CO
MBO
The verify panel reason filter combo
409
BXID_VERIFY_PANEL_FILTER_COLOR
The verify panel color filter button
410
BXID_VERIFY_PANEL_COLOR_SELECT
The verify panel color selection button
VerifyPanel


Page 25
ID
Symbolic Name
Type
Description
411
BXID_VERIFY_PANEL_SEARCH_TARGET
The verify panel dropdown specifying a

search target
412
BXID_VERIFY_PANEL_VERIFY_TEXT
The verify panel text "Verify"
413
BXID_VERIFY_PANEL_POSITION_TEXT
The verify panel text showing the current

position
414
BXID_VERIFY_PANEL_TEXT_HIDDEN_TEXT
The verify panel text indicating that

document text is hidden
415
BXID_VERIFY_PANEL_HORZTOP_SEP
The verify panel top horizontal separator
416
BXID_VERIFY_PANEL_HORZ_SEP
The verify panel horizontal separator
BookmarkPanel
500
BXID_BOOKMARK_PANEL
The bookmark panel
501
BXID_BOOKMARK_PANEL_PREV
The bookmark panel previous bookmark

button
502
BXID_BOOKMARK_PANEL_NEXT
The bookmark panel next bookmark

button
503
BXID_BOOKMARK_PANEL_HELP
The bookmark panel help button
504
BXID_BOOKMARK_PANEL_SEARCH_BUTTO
N
The bookmark panel search button
505
BXID_BOOKMARK_PANEL_SEARCH_COMB
O
The bookmark panel search combo
506
BXID_BOOKMARK_PANEL_SEARCH_SEP
The bookmark panel search separator
507
BXID_BOOKMARK_PANEL_BOOKMARKS
The bookmark panel bookmark display
ChangemarkPanel
600
BXID_CHANGEMARK_PANEL
The changemark panel
601
BXID_CHANGEMARK_PANEL_NEXT
The changemark panel next changemark

button
602
BXID_CHANGEMARK_PANEL_PREV
The changemark panel previous

changemark button
603
BXID_CHANGEMARK_PANEL_FIND_OPTION
S
The changemark panel find options button
604
BXID_CHANGEMARK_PANEL_FIND_RESET
The changemark panel find reset button
605
BXID_CHANGEMARK_PANEL_COPY
The changemark panel copy Changemark

button
606
BXID_CHANGEMARK_PANEL_HELP
The changemark panel help button
607
BXID_CHANGEMARK_PANEL_HELP_SEP
The changemark panel help separator
608
BXID_CHANGEMARK_PANEL_REPLY
The changemark panel reply button
609
BXID_CHANGEMARK_PANEL_SORT
The changemark panel sort button
610
BXID_CHANGEMARK_PANEL_TITLE_LIST
The changemark panel title list control
611
BXID_CHANGEMARK_PANEL_TEXT
The changemark panel changemark text

control
612
BXID_CHANGEMARK_PANEL_FIND
The changemark panel find combo


Page 26
ID
Symbolic Name
Type
Description
613
BXID_CHANGEMARK_PANEL_TYPE
The changemark panel changemark type

control
614
BXID_CHANGEMARK_PANEL_STATE
The changemark panel changemark state

control
MeasurePanel
700
BXID_MEASURE_TAKEOFF_PANEL
The measure take off panel
701
BXID_MEASURE_TAKEOFF_NEW_CATEGOR
Y
The measure take off new category button
702
BXID_MEASURE_TAKEOFF_EDIT_CATEGOR
Y
The measure take off edit category button
703
BXID_MEASURE_TAKEOFF_DELETE_CATEG
ORY
The measure take off delete category

button
704
BXID_MEASURE_TAKEOFF_EXPORT
The measure take off export button
705
BXID_MEASURE_TAKEOFF_CATEGORY_LIS
T
The measure take off category list
706
BXID_MEASURE_TAKEOFF_LABEL_TOTAL
The measure take off total label
707
BXID_MEASURE_TAKEOFF_LABEL_TYPE
The measure take off type label
708
BXID_MEASURE_TAKEOFF_EDIT_TOTAL
The measure take off total edit control
709
BXID_MEASURE_TAKEOFF_MESSAGE
The measure take off total message
710
BXID_MEASURE_TAKEOFF_LABEL_SCALE
The measure take off scale label
711
BXID_MEASURE_TAKEOFF_EDIT_SCALE
The measure take off scale edit control
ComparisonBar
800
BXID_COMPARE_BAR
The compare toolbar
801
BXID_COMPARE_BAR_ALIGN
The compare bar align button
802
BXID_COMPARE_BAR_ALIGN_CLEAR
The compare bar clear alignment button
803
BXID_COMPARE_BAR_HELP
The compare bar help button
804
BXID_COMPARE_BAR_OVERLAY
The compare bar overlay button
805
BXID_COMPARE_BAR_OVERLAY_DIFF
The compare bar overlay differences

button
806
BXID_COMPARE_BAR_SIDE_BY_SIDE
The compare bar side by side button
807
BXID_COMPARE_BAR_TEXT_COMPARE
The compare bar text compare button
808
BXID_COMPARE_BAR_OPEN_FILE
The compare bar open file button
809
BXID_COMPARE_BAR_COMPARE_FILE
The compare bar compare file button
810
BXID_COMPARE_BAR_ADDITIONS
The compare bar additions button
811
BXID_COMPARE_BAR_DELETIONS
The compare bar deletions button
812
BXID_COMPARE_BAR_UNCHANGED
The compare bar unchanged button
813
BXID_COMPARE_BAR_NUDGE
The compare bar nudge button
814
BXID_COMPARE_BAR_ALIGN_HELP
The compare bar align instructions


Page 27
ID
Symbolic Name
Type
Description
815
BXID_COMPARE_BAR_TRANSPARENCY_SLI
DER
The compare bar overlay transparency

slider
816
BXID_COMPARE_BAR_REPORT
The compare bar report button
817
BXID_COMPARE_BAR_SETTINGS
The compare bar settings button
900
BXID_TEXT_COMPARE
The text compare window
901
BXID_TEXT_COMPARE_COMPARISON
The text compare comparison control
902
BXID_TEXT_COMPARE_ARROW_INDICATO
R
The text compare active document arrow

indicators
903
BXID_TEXT_COMPARE_OPEN_FILE_TEXT
The text compare text indicating the open

document
904
BXID_TEXT_COMPARE_COMPARE_FILE_TE
XT
The text compare text indicating the

compare document
905
BXID_TEXT_COMPARE_POSITION_TEXT
The text compare text indicating the

current compare position
906
BXID_TEXT_COMPARE_TOP_SEP
The text compare top separator
907
BXID_TEXT_COMPARE_BOTTOM_SEP
The text compare bottom separator
908
BXID_TEXT_COMPARE_NEXT
The text compare next difference button
909
BXID_TEXT_COMPARE_PREV
The text compare previous difference

button
[None]
NavigationBar
1000
BXID_NAVIGATION_BAR
The bottom navigation bar
1001
BXID_NAV_BAR_PREV_PAGE
The navigation bar previous page button
1002
BXID_NAV_BAR_NEXT_PAGE
The navigation bar next page button
1003
BXID_NAV_BAR_PAGE_COMBO
The navigation bar page combo
1004
BXID_NAV_BAR_ROTATE
The navigation bar rotate button
1005
BXID_NAV_BAR_FITALL
The navigation bar fit all button
1006
BXID_NAV_BAR_FITWIDTH
The navigation bar fit width button
1007
BXID_NAV_BAR_ZOOM_SLIDER
The navigation bar zoom slider
1008
BXID_NAV_BAR_PAN
The navigation bar pan button
1009
BXID_NAV_BAR_ZOOM_RECT
The navigation bar zoom rect tool button
1010
BXID_NAV_BAR_MAGNIFIER
The navigation bar magnifier tool button
1011
BXID_NAV_BAR_BACKGROUND_COLOR
The navigation bar background color

button
1012
BXID_NAV_BAR_LAYERS
The navigation bar layers button
The horizontal scroll bar
HorizontalScrollBar
1100
BXID_HORIZONTAL_SCROLL_BAR
[None]

Page 28
ID
Symbolic Name
Type
Description
1200
BXID_VERTICAL_SCROLL_BAR
The vertical scroll bar
1300
BXID_TEXT_SEARCH_BAR
The text search control
1301
BXID_TEXT_SEARCH_FIND_COMBO
The text search find combo
1302
BXID_TEXT_SEARCH_FIND_BUTTON
The text search find button
1400
BXID_FOCUS_INFO_BAR
The focus pane information bar
1401
BXID_FOCUS_INFO_CLOSE
The focus view close button
1402
BXID_FOCUS_INFO_HELP
The focus view help button
1403
BXID_FOCUS_INFO_VIEWED_TEXT
The focus view viewed text label
1404
BXID_FOCUS_INFO_VIEWED_PROGRESS
The focus view viewed progress label
1405
BXID_FOCUS_INFO_PAGE
The focus view page label
1406
BXID_FOCUS_INFO_RESTART
The focus view restart button
1407
BXID_FOCUS_INFO_SIZE
The focus view size button
1408
BXID_FOCUS_SCROLL_BAR
The scroll controls in the focus view
1409
BXID_FOCUS_SCROLL_BAR_PAGE_UP
The focus view page up button
1410
BXID_FOCUS_SCROLL_BAR_UP
The focus view up button
1411
BXID_FOCUS_SCROLL_BAR_DOWN
The focus view down button
1412
BXID_FOCUS_SCROLL_BAR_PAGE_DOWN
The focus view page down button
TextSearch
[None]
InformationBar
1500
BXID_INFO_BAR
The toolbar containing the markup

properties, measure results, and text find
controls
1501
BXID_INFO_BAR_HELP
The help button on the info bar
1502
BXID_INFO_BAR_FILE_DISPLAY_NAME
The filename displayed on the info bar
MeasurementResults
1600
BXID_MEASURE_RESULTS_BAR
The measure results bar
1601
BXID_MEASURE_RESULTS_DISTANCE
The measure take off distance label
1602
BXID_MEASURE_RESULTS_RADIUS
The measure take off radius label
1603
BXID_MEASURE_RESULTS_COUNT
The measure take off count label
1604
BXID_MEASURE_RESULTS_RESULT1
The measure take off first results text
1605
The measure take off second results text
1606
The measure take off third results text
1607
The measure take off fourth results text
1608
BXID_MEASURE_RESULTS_PERIMETER
The measure take off perimeter label
1609
BXID_MEASURE_RESULTS_TOTAL_DISTAN
The measure take off total distance label


Page 29
ID
Symbolic Name
Type
Description
CE
1610
BXID_MEASURE_RESULTS_HEIGHT
The measure take off height label
1611
BXID_MEASURE_RESULTS_CIRCUMFERENC
E
The measure take off circumference label
1612
BXID_MEASURE_RESULTS_ANGLE
The measure take off angle label
1613
BXID_MEASURE_RESULTS_RECT_AREA
The measure take off rectangle area label
1614
BXID_MEASURE_RESULTS_POLY_AREA
The measure take off poly area label
1615
BXID_MEASURE_RESULTS_CIRCLE_AREA
The measure take off circle area label
1616
BXID_MEASURE_RESULTS_REMOVE_LAST_
COUNT
The measure take off remove last count

button
1617
BXID_MEASURE_RESULTS_REMOVE_ALL_C
OUNT
The measure take off remove all count

button
1618
BXID_MEASURE_RESULTS_CURSOR_POS
The measure take off cursor position label
1619
BXID_MEASURE_RESULTS_SNAP
The measure take off snap checkbox
1620
BXID_MEASURE_RESULTS_NEG_AREA
The measure take off negative area

checkbox
1621
BXID_MEASURE_RESULTS_SHOW_LEADER
The measure take off show leader

checkbox
MarkupProperties
1700
BXID_MARKUP_PROPERTIES_BAR
The bar containing information on markup

properties
1701
BXID_MRK_PROP_COLOR
The markup properties color button
1702
BXID_MRK_PROP_FILL
The markup properties fill combo
1703
BXID_MRK_PROP_LINE_WEIGHT
The markup properties line weight combo
1704
BXID_MRK_PROP_LINE_STYLE
The markup properties line style combo
1705
BXID_MRK_PROP_ARROW_HEAD
The markup properties arrow head combo
1706
BXID_MRK_PROP_ARROW_TAIL
The markup properties arrow tail combo
1707
BXID_MRK_PROP_FONT
The markup properties font combo
1708
BXID_MRK_PROP_FONT_SIZE
The markup properties font size combo
1709
BXID_MRK_PROP_STAMP
The markup properties stamp combo
1710
BXID_MRK_PROP_BROWSE_STAMP
The markup properties browse for stamp

button
1711
BXID_MRK_PROP_IMAGE
The markup properties image combo
1712
BXID_MRK_PROP_BROWSE_IMAGE
The markup properties browse for image

button
1713
BXID_MRK_PROP_TEXT_BACKGROUND
The markup properties text background

button
1714
BXID_MRK_PROP_TEXT_UNDERLINE
The markup properties text underline

button
1715
BXID_MRK_PROP_TEXT_ITALICS
The markup properties text italics button


Page 30
ID
Symbolic Name
Type
Description
1716
BXID_MRK_PROP_TEXT_BOLD
The markup properties text bold button
1717
BXID_MRK_PROP_VARIABLE_TEXT
The markup properties variable text

button
1718
BXID_MRK_PROP_HYPERLINK
The markup properties hyperlink button
1719
BXID_MRK_PROP_COPY_TO_PAGES
The markup properties copy to pages

button
1720
BXID_MRK_PROP_REDACTION_REASON
The redaction reason combo
1721
BXID_MRK_PROP_REDACTION_REASON_L
ABEL
The redaction reason label
MeasurementTools
1800
BXID_MEASURE_TOOLS_BAR
The measure toolbar
1801
BXID_MEASURE_TOOLS_LINE
The measure line tool button
1802
BXID_MEASURE_TOOLS_POLYLINE
The measure polyline tool button
1803
BXID_MEASURE_TOOLS_POLYGON
The measure polygon tool button
1804
BXID_MEASURE_TOOLS_RECTANGLE
The measure rectangle tool button
1805
BXID_MEASURE_TOOLS_CIRCLE
The measure circle tool button
1806
BXID_MEASURE_TOOLS_COUNT
The measure count tool button
MarkupTools
1900
BXID_MARKUP_TOOLS_BAR
The markup toolbar
1901
BXID_MARKUP_TOOLS_POPOUT
The popout menu that appears from the

measure toolbar
1902
BXID_MARKUP_TOOLS_SELECT
The markup select tool button
1903
BXID_MARKUP_TOOLS_ARROW_LINE
The markup arrow line tool button
1904
BXID_MARKUP_TOOLS_TEXT
The markup text tool button
1905
BXID_MARKUP_TOOLS_IMAGE
The markup image tool button
1906
BXID_MARKUP_TOOLS_STAMP
The markup stamp tool button
1907
BXID_MARKUP_TOOLS_CLOUD
The markup cloud tool button
1908
BXID_MARKUP_TOOLS_POLYCLOUD
The markup polycloud tool button
1909
BXID_MARKUP_TOOLS_HIGHLIGHT
The markup highlight tool button
1910
BXID_MARKUP_TOOLS_CHANGEMARK
The markup changemark tool button
1911
BXID_MARKUP_TOOLS_HIGHLIGHT_TEXT_
CHANGEMARK
The markup highlight text changemark

tool button
1912
BXID_MARKUP_TOOLS_HIGHLIGHT_CHAN
GEMARK
The markup highlight changemark tool

button
1913
BXID_MARKUP_TOOLS_CLOUD_CHANGEM
ARK
The markup cloud changemark tool button
1914
BXID_MARKUP_TOOLS_ARROW_CHANGEM
ARK
The markup arrow changemark tool

button
1915
BXID_MARKUP_TOOLS_SKETCH
The markup sketch tool button


Page 31
ID
Symbolic Name
Type
Description
1916
BXID_MARKUP_TOOLS_SKETCH_POLYGON
The markup sketch polygon tool button
1917
BXID_MARKUP_TOOLS_LINE
The markup line tool button
1918
BXID_MARKUP_TOOLS_POLYLINE
The markup polyline tool button
1919
BXID_MARKUP_TOOLS_ARC
The markup arc tool button
1920
BXID_MARKUP_TOOLS_X_OUT
The markup cross out tool button
1921
BXID_MARKUP_TOOLS_SCRATCH_OUT
The markup scratch out tool button
1922
BXID_MARKUP_TOOLS_ARROW_POINTER
The markup arrow pointer tool button
1923
BXID_MARKUP_TOOLS_RECTANGLE
The markup rectangle tool button
1924
BXID_MARKUP_TOOLS_ROUNDED_RECTAN
GLE
The markup rounded rectangle tool button
1925
BXID_MARKUP_TOOLS_POLYGON
The markup polygon tool button
1926
BXID_MARKUP_TOOLS_ELLIPSE
The markup ellipse tool button
1927
BXID_MARKUP_TOOLS_STRIKEOUT
The markup strikeout tool button
1928
BXID_MARKUP_TOOLS_STRIKETHROUGH
The markup strikethrough tool button
1929
BXID_MARKUP_TOOLS_HIGHLIGHT_TEXT
The markup highlight text tool button
1930
BXID_MARKUP_TOOLS_UNDERLINE
The markup underline text tool button
RedactionTools
2000
BXID_REDACTION_TOOLS_BAR
The redaction toolbar
2001
BXID_REDACTION_TOOLS_SELECT
The redaction select tool button
2002
BXID_REDACTION_TOOLS_REDACT
The redact tool button
2003
BXID_REDACTION_TOOLS_REDACT_ALLO
W
The redaction allow area tool button
2004
BXID_REDACTION_TOOLS_PRIVACY
The redact privacy button
2005
BXID_REDACTION_TOOLS_FIND_AND_RED
ACT
The find and redact button
2006
BXID_REDACTION_TOOLS_FROM_TO
The redact from - to button
2007
BXID_REDACTION_TOOLS_SCRIPT
The redaction script button
2008
BXID_REDACTION_TOOLS_PAGE
The redact page button
2009
BXID_REDACTION_TOOLS_IMAGE
The redact image button
2010
BXID_REDACTION_TOOLS_TEXT
The redact text button
TakeoffTools
2100
BXID_TAKEOFF_TOOLS_BAR
The measure take off toolbar
2101
BXID_TAKEOFF_TOOLS_SELECT
The take off select button
2102
BXID_TAKEOFF_TOOLS_LINE
The take off line button
2103
BXID_TAKEOFF_TOOLS_POLYLINE
The take off polyline button
2104
BXID_TAKEOFF_TOOLS_POLYGON
The take off polygon button
2105
BXID_TAKEOFF_TOOLS_RECTANGLE
The take off rectangle button


Page 32
ID
Symbolic Name
Type
Description
2106
BXID_TAKEOFF_TOOLS_CIRCLE
The take off circle button
2107
BXID_TAKEOFF_TOOLS_COUNT
The take off count button
2200
BXID_SPLASH_LINK1
The splash link 1
2201
BXID_SPLASH_LINK2
The splash link 2
2202
BXID_SPLASH_LINK3
The splash link 3
2203
BXID_SPLASH_LINK4
The splash link 4
2204
BXID_SPLASH_LINK5
The splash link 5
2205
BXID_SPLASH_PIC
The splash pic
2206
BXID_SPLASH_CLOSE
The close pic
2207
BXID_SPLASH_STRING_VERSION
The version string
2208
BXID_SPLASH_STRING_SKU
The sku string
2209
BXID_SPLASH_STRING_EXPIRATION
The expiration string
2210
BXID_SPLASH_STRING_INTEGRATIONINFO
The integration specific string(bex)
2300
BXID_DOCUMENT_DRAWING_WND
The main window for rendering drawings

and documents
100000
BXID_RIGHT_CLICK_MRK_EDIT_CUT
The markup right-click cut command
100001
BXID_RIGHT_CLICK_MRK_EDIT_COPY
The markup right-click copy command
100002
BXID_RIGHT_CLICK_MRK_EDIT_PASTE
The markup right-click paste command
100003
BXID_RIGHT_CLICK_MRK_EDIT_DELETE
The markup right-click delete command
100004
BXID_RIGHT_CLICK_MRK_EDIT_SELECT_A
LL
The markup right-click select all command
100005
BXID_RIGHT_CLICK_MRK_EDIT_SYM_PLUS
_MINUS
The markup right-click +/- symbol
100006
BXID_RIGHT_CLICK_MRK_EDIT_SYM_DIA
METER
The markup right-click diameter symbol
100007
BXID_RIGHT_CLICK_MRK_EDIT_SYM_DEG
REE
The markup right-click degree symbol
100008
BXID_RIGHT_CLICK_MRK_EDIT_SYM_COP
YRIGHT
The markup right-click copyright symbol
100009
BXID_RIGHT_CLICK_MRK_EDIT_SYM_REGI
STERED
The markup right-click register symbol
100100
BXID_RIGHT_CLICK_MRK_TEXT_BKGD_TR
ANSPARENT
The markup properties right-click text

background transparent option
100101
BXID_RIGHT_CLICK_MRK_TEXT_BKGD_OP
AQUE

background opaque option
100102
BXID_RIGHT_CLICK_MRK_TEXT_BKGD_CU
RRENT

background current option
100103
BXID_RIGHT_CLICK_MRK_TEXT_BKGD_SE
[None]
[None]


Page 33
ID
Symbolic Name
Type
LECT
Description
background select option
100200
BXID_RIGHT_CLICK_PREV_VIEW
The right-click previous view command
100201
BXID_RIGHT_CLICK_FIT_ALL
The right-click fit all command
100202
BXID_RIGHT_CLICK_FIT_WIDTH
The right-click fit width command
100203
BXID_RIGHT_CLICK_PAN
The right-click pan tool command
100204
BXID_RIGHT_CLICK_COPY
The right-click copy command
100205
BXID_RIGHT_CLICK_PASTE
The right-click paste command
100206
BXID_RIGHT_CLICK_DELETE
The right-click delete command
100207
BXID_RIGHT_CLICK_UNDO
The right-click undo command
100208
BXID_RIGHT_CLICK_REDO
The right-click redo command
100209
BXID_RIGHT_CLICK_COPY_REGION
The right-click copy region command
100210
BXID_RIGHT_CLICK_REDACT_SELECTION
The right-click redact selection command
100300
BXID_RIGHT_CLICK_PAGE_SUBMENU
The right-click page submenu
100301
BXID_RIGHT_CLICK_PAGE_NEXT
The right-click page submenu next page

command
100302
BXID_RIGHT_CLICK_PAGE_PREV
The right-click page submenu previous

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

command
100304
BXID_RIGHT_CLICK_PAGE_LAST
The right-click page submenu last page

command
100305
BXID_RIGHT_CLICK_PAGE_PREV_MRK
The right-click page submenu previous

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

markup page command
100400
BXID_RIGHT_CLICK_MARKS
The right-click marks submenu
100401
BXID_RIGHT_CLICK_MARKS_ADD_PLACEK
EEPER
The right-click marks submenu add

placekeeper command
100402
BXID_RIGHT_CLICK_MARKS_NEXT_PLACE
KEEPER
The right-click marks submenu next

placekeeper command
100403
BXID_RIGHT_CLICK_MARKS_PREV_PLACE
KEEPER
The right-click marks submenu previous

placekeeper command
100404
BXID_RIGHT_CLICK_MARKS_REMOVE_PLA
CEKEEPER
The right-click marks submenu remove all

placekeepers command
100405
BXID_RIGHT_CLICK_MARKS_NEXT_BOOK
MARK

bookmark command
100406
BXID_RIGHT_CLICK_MARKS_PREV_BOOKM
ARK

bookmark command
100407
BXID_RIGHT_CLICK_MARKS_NEXT_CHANG
EMARK

changemark command
100408
BXID_RIGHT_CLICK_MARKS_PREV_CHANG
EMARK

changemark command


Page 34
ID
Symbolic Name
100500
BXID_RIGHT_CLICK_ROTATE
The right-click rotate/mirror submenu
100501
BXID_RIGHT_CLICK_ROTATE_CLOCKWISE

rotate clockwise command
100502
BXID_RIGHT_CLICK_ROTATE_COUNTERCL
OCKWISE

rotate counterclockwise command
100503
BXID_RIGHT_CLICK_ROTATE_MIRROR

mirror command
100600
BXID_RIGHT_CLICK_COLOR
The right-click background color submenu
100601
BXID_RIGHT_CLICK_COLOR_BLACK

black option
100602
BXID_RIGHT_CLICK_COLOR_WHITE

white option
100603
BXID_RIGHT_CLICK_COLOR_GRAY

gray option
100604
BXID_RIGHT_CLICK_COLOR_DEFAULT

default option
100700
BXID_RIGHT_CLICK_OPTIONS
The right-click options submenu
100701
BXID_RIGHT_CLICK_OPTIONS_ANIMATE
The right-click options submenu animate

option
100702
BXID_RIGHT_CLICK_OPTIONS_LINE_WEIG
HTS
The right-click options submenu line

weights option
100704
BXID_RIGHT_CLICK_OPTIONS_SMOOTH_E
DGES
The right-click options submenu smooth

edges option
100800
BXID_RIGHT_CLICK_SHOW_PANE
The right-click show pane submenu
100801
BXID_RIGHT_CLICK_SHOW_PANE_THUMB
NAILS

thumbnails command
100802
BXID_RIGHT_CLICK_SHOW_PANE_BOOKM
ARKS

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

command
100804
BXID_RIGHT_CLICK_SHOW_PANE_CHANG
EMARKS

Changemark command
100805
BXID_RIGHT_CLICK_SHOW_PANE_MEASU
RETAKEOFF

Changemark command
100900
BXID_VAR_TEXT_MENU_DATE
The variable text menu date option
100901
BXID_VAR_TEXT_MENU_SYSDATE
The variable text menu sys date plus days

option
100902
BXID_VAR_TEXT_MENU_TIME
The variable text menu time option
100903
BXID_VAR_TEXT_MENU_MILTIME
The variable text menu military time

option
100904
BXID_VAR_TEXT_MENU_TITLE
The variable text menu title option
100905
BXID_VAR_TEXT_MENU_PAGES
The variable text menu pages option
100906
BXID_VAR_TEXT_MENU_TOTAL_PAGES
The variable text menu total pages option
100907
BXID_VAR_TEXT_MENU_BATES_PG_NUM
The variable text menu Bates number

Type
Description

Page 35
ID
Symbolic Name
Type
Description
option
100908
BXID_VAR_TEXT_MENU_LOGIN
The variable text menu login option
100909
BXID_VAR_TEXT_MENU_USER
The variable text menu user option
100910
BXID_VAR_TEXT_MENU_PROMPT
The variable text menu prompt option
100911
BXID_VAR_TEXT_MENU_DBSTRING
The variable text menu DBString option
100912
BXID_VAR_TEXT_MENU_DBUPDATESTRING
The variable text menu DBUpdateString

option
100913
BXID_VAR_TEXT_MENU_PERCENT
The variable text menu % option
100914
BXID_VAR_TEXT_MENU_HOSTNAME
The variable text menu hostname option
100915
BXID_VAR_TEXT_MENU_IPADDRESS
The variable text menu ipaddress option
100916
BXID_VAR_TEXT_MENU_SYM_REGISTERED
The variable text menu registered symbol

option
100917
BXID_VAR_TEXT_MENU_SYM_COPYRIGHT
The variable text menu copyright symbol

option
101000
BXID_MRK_MENU_NEW
The markup menu new command
101001
BXID_MRK_MENU_OPEN
The markup menu open command
101002
BXID_MRK_MENU_SAVE
The markup menu save command
101003
BXID_MRK_MENU_SAVE_AS
The markup menu save as command
101004
BXID_MRK_MENU_CLOSE
The markup menu close command
101005
BXID_MRK_MENU_CONSOLIDATE
The markup menu consolidate command
101006
BXID_MRK_MENU_NEW_STAMP
The markup menu new stamp template

command
101007
BXID_MRK_MENU_OPEN_STAMP
The markup menu open stamp template

command
101008
BXID_MRK_MENU_SAVE_STAMP
The markup menu save stamp template

command
101009
BXID_MRK_MENU_SAVE_AS_STAMP
The markup menu save as stamp

template command
101010
BXID_MRK_MENU_CLOSE_STAMP
The markup menu close stamp template

command
101011
BXID_MRK_MENU_SAVE_AS_DXF
The markup menu save as DXF command
101100
BXID_CM_FIND_MENU_CUMULATIVE
The changemark panel find menu

cumulative option
101101
BXID_CM_FIND_MENU_WHOLE_WORD
The changemark panel find menu whole

word option
101102
BXID_CM_FIND_MENU_MATCH_CASE
The changemark panel find menu match

case option
101103
BXID_CM_FIND_MENU_TERM_HIT
The changemark panel find menu term hit

option
101200
BXID_CM_SORT_MENU_TITLE
The changemark panel sort menu title

option
101201
BXID_CM_SORT_MENU_AUTHOR
The changemark panel sort menu author


Page 36
ID
Symbolic Name
Type
Description
option
101202
BXID_CM_SORT_MENU_DATE
The changemark panel sort menu date

option
101203
BXID_CM_SORT_MENU_TYPE
The changemark panel sort menu type

option
101204
BXID_CM_SORT_MENU_STATE
The changemark panel sort menu state

option
101205
BXID_CM_SORT_MENU_POSITION
The changemark panel sort menu position

option
101300
BXID_COMPARE_MENU_NUDGE_LEFT
The compare toolbar nudge left menu

option
101301
BXID_COMPARE_MENU_NUDGE_RIGHT
The compare toolbar nudge right menu

option
101302
BXID_COMPARE_MENU_NUDGE_UP
The compare toolbar nudge up menu

option
101303
BXID_COMPARE_MENU_NUDGE_DOWN
The compare toolbar nudge down menu

option
101400
BXID_FIND_MENU_DOWN
The find menu down option
101401
BXID_FIND_MENU_UP
The find menu up option
101402
BXID_FIND_MENU_MATCH_CASE
The find menu match case option
101403
BXID_FIND_MENU_WHOLE_WORD
The find menu whole word only option
101404
BXID_FIND_MENU_REGEX
The find menu regular expressions option
101405
BXID_FIND_MENU_TERMHIT
The find menu term hit option
101500
BXID_COLOR_MENU_BLACK
The navigation toolbar color menu black

option
101501
BXID_COLOR_MENU_WHITE
The navigation toolbar color menu white

option
101502
BXID_COLOR_MENU_GRAY
The navigation toolbar color menu gray

option
101503
BXID_COLOR_MENU_DEFAULT
The navigation toolbar color menu default

option
101504
BXID_COLOR_MENU_MONOCHROME
The navigation toolbar color menu

monochrome option
101600
BXID_PRINT_MENU_PRINT
The print menu print option
101601
BXID_PRINT_MENU_PRINT_REGION
The print menu print region option
101602
BXID_PRINT_MENU_BANNERS
The print menu ISO banners option
101700
BXID_REVIEW_MENU_CLOSE
The review menu close review option
101701
BXID_REVIEW_MENU_CM_REVIEW
The review menu changemark review

option
101702
BXID_REVIEW_MENU_CM_NEXT
The review menu next changemark option
101703
BXID_REVIEW_MENU_CM_PREV
The review menu prev changemark option
101800
BXID_REDACT_MENU_SAVE
The redact menu publish submenu


Page 37
ID
Symbolic Name
Type
Description
101801
BXID_REDACT_MENU_SAVE_PDF
The redact menu publish to PDF option
101802
BXID_REDACT_MENU_SAVE_TIFF
The redact menu publish to TIFF option
101803
BXID_REDACT_MENU_SAVE_DRAFT
The redact menu publish to draft

submenu
101804
BXID_REDACT_MENU_SAVE_PDF_DRAFT
The redact menu publish to draft PDF

option
101805
BXID_REDACT_MENU_SAVE_TIFF_DRAFT
The redact menu publish to draft TIFF

option
101806
BXID_REDACT_MENU_OPEN_TEMPLATE
The redact menu open redactup template

option
101807
BXID_REDACT_MENU_RUN_SCRIPT
The redact menu run script option
101808
BXID_REDACT_MENU_VERIFY
The redact menu verify submenu
101809
BXID_REDACT_MENU_VERIFY_REDACTUPS
The redact menu verify submenu

redactups option
101810
BXID_REDACT_MENU_VERIFY_IMAGES
The redact menu verify submenu image

areas option
101811
BXID_REDACT_MENU_VERIFY_DOCUMENT
The redact menu verify submenu entire

document option
101812
BXID_REDACT_MENU_SAVE_CSF
The redact menu publish to CSF
101900
BXID_MEASURE_MENU_TAKEOFF
The measure menu measure/takeoff

option
101901
BXID_MEASURE_MENU_CALIBRATE
The measure menu calibrate option
101902
BXID_MEASURE_MENU_SETTINGS
The measure menu settings option
102000
BXID_PUBLISH_MENU_CSF
The publish menu publish to CSF option
102001
BXID_PUBLISH_MENU_DWF
The publish menu publish to DWF option
102002
BXID_PUBLISH_MENU_JPG
The publish menu save as jpg option
102100
BXID_HELP_MENU_CONTENTS
The help menu contents option
102101
BXID_HELP_MENU_ABOUT
The help menu about option
102102
BXID_HELP_MENU_SUGGEST
The help menu suggest new feature

option
102200
BXID_THUMBNAIL_MENU_REDUCE
The thumbnail menu option reduce
102201
BXID_THUMBNAIL_MENU_ENLARGE
The thumbnail menu option enlarge
102202
BXID_THUMBNAIL_MENU_DEFAULT
The thumbnail menu option default
102300
BXID_EXTERNAL_BOOKMARK_OPEN
The external bookmark menu option open
102301
BXID_EXTERNAL_BOOKMARK_ADD
The external bookmark menu option add
102302
BXID_EXTERNAL_BOOKMARK_DELETE
The external bookmark menu option

delete
[None]
500000
BXID_EXTERNAL_BUTTON_START

Initial offset of externally defined

commands

Page 38
Appendix B: Color Specification

Colorspecs can be encoded as either a hexadecimal ARGB value:
<... value="#ff208040"/>
Or, by using one of the predefined color names:
<... value="DarkSlateGray"/>
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
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.
<... value="#70"/>
Channel
Hexadecimal
ff
70
Decimal
255
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:
<... value="#c0a940"/>
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.


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


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


Page 41
AliceBlue
#fff0f8ff
AntiqueWhite
#fffaebd7
Gray
#ff808080
Orange
#ffffa500
Aqua
#ff00ffff
Green
#ff008000
OrangeRed
#ffff4500
Aquamarine
#ff7fffd4
GreenYellow
#ffadff2f
Orchid
#ffda70d6
Azure
#fff0ffff
Honeydew
#fff0fff0
PaleGoldenrod
#ffeee8aa
Beige
#fff5f5dc
HotPink
#ffff69b4
PaleGreen
#ff98fb98
Bisque
#ffffe4c4
IndianRed
#ffcd5c5c
PaleTurquoise
#ffafeeee
Black
#ff000000
Indigo
#ff4b0082
PaleVioletRed
#ffdb7093
BlanchedAlmond
#ffffebcd
Ivory
#fffffff0
PapayaWhip
#ffffefd5
Blue
#ff0000ff
Khaki
#fff0e68c
PeachPuff
#ffffdab9
BlueViolet
#ff8a2be2
Lavender
#ffe6e6fa
Peru
#ffcd853f
Brown
#ffa52a2a
LavenderBlush
#fffff0f5
Pink
#ffffc0cb
BurlyWood
#ffdeb887
LawnGreen
#ff7cfc00
Plum
#ffdda0dd
CadetBlue
#ff5f9ea0
LemonChiffon
#fffffacd
PowderBlue
#ffb0e0e6
Chartreuse
#ff7fff00
LightBlue
#ffadd8e6
Purple
#ff800080
Chocolate
#ffd2691e
LightCoral
#fff08080
Red
#ffff0000
Coral
#ffff7f50
LightCyan
#ffe0ffff
RosyBrown
#ffbc8f8f
CornflowerBlue
#ff6495ed
LightGoldenrodYellow
#fffafad2
RoyalBlue
#ff4169e1
Cornsilk
#fffff8dc
LightGray
#ffd3d3d3
SaddleBrown
#ff8b4513
Crimson
#ffdc143c
LightGreen
#ff90ee90
Salmon
#fffa8072
Cyan
#ff00ffff
LightPink
#ffffb6c1
SandyBrown
#fff4a460
DarkBlue
#ff00008b
LightSalmon
#ffffa07a
SeaGreen
#ff2e8b57
DarkCyan
#ff008b8b
LightSeaGreen
#ff20b2aa
SeaShell
#fffff5ee
DarkGoldenrod
#ffb8860b
LightSkyBlue
#ff87cefa
Sienna
#ffa0522d
DarkGray
#ffa9a9a9
LightSlateGray
#ff778899
Silver
#ffc0c0c0
DarkGreen
#ff006400
LightSteelBlue
#ffb0c4de
SkyBlue
#ff87ceeb
DarkKhaki
#ffbdb76b
LightYellow
#ffffffe0
SlateBlue
#ff6a5acd
DarkMagenta
#ff8b008b
Lime
#ff00ff00
SlateGray
#ff708090
DarkOliveGreen
#ff556b2f
LimeGreen
#ff32cd32
Snow
#fffffafa
DarkOrange
#ffff8c00
Linen
#fffaf0e6
SpringGreen
#ff00ff7f
DarkOrchid
#ff9932cc
Magenta
#ffff00ff
SteelBlue
#ff4682b4
DarkRed
#ff8b0000
Maroon
#ff800000
Tan
#ffd2b48c
DarkSalmon
#ffe9967a
MediumAquamarine
#ff66cdaa
Teal
#ff008080
DarkSeaGreen
#ff8fbc8b
MediumBlue
#ff0000cd
Thistle
#ffd8bfd8
DarkSlateBlue
#ff483d8b
MediumOrchid
#ffba55d3
Tomato
#ffff6347
DarkSlateGray
#ff2f4f4f
MediumPurple
#ff9370db
Transparent
#00ffffff
DarkTurquoise
#ff00ced1
MediumSeaGreen
#ff3cb371
Turquoise
#ff40e0d0
DarkViolet
#ff9400d3
MediumSlateBlue
#ff7b68ee
Violet
#ffee82ee
DeepPink
#ffff1493
MediumSpringGreen
#ff00fa9a
Wheat
#fff5deb3
DeepSkyBlue
#ff00bfff
MediumTurquoise
#ff48d1cc
White
#ffffffff
DimGray
#ff696969
MediumVioletRed
#ffc71585
WhiteSmoke
#fff5f5f5
DodgerBlue
#ff1e90ff
MidnightBlue
#ff191970
Yellow
#ffffff00
Firebrick
#ffb22222
MintCream
#fff5fffa
YellowGreen
#ff9acd32
FloralWhite
#fffffaf0
MistyRose
#ffffe4e1
ForestGreen
#ff228b22
Moccasin
#ffffe4b5
Fuchsia
#ffff00ff
NavajoWhite
#ffffdead
Gainsboro
#ffdcdcdc
Navy
#ff000080
GhostWhite
#fff8f8ff
OldLace
#fffdf5e6
Gold
#ffffd700
Olive
#ff808000
Goldenrod
#ffdaa520
OliveDrab
#ff6b8e23


Page 42
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
<xs:schema
targetNamespace="http://schemas.infograph.com/igc-brava-theme.xsd"
attributeFormDefault="unqualified"
elementFormDefault="qualified"
xmlns="http://schemas.infograph.com/igc-brava-theme.xsd"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:simpleType name="region_decl">
<xs:restriction base="xs:string">
<xs:enumeration value="TaskRegion"/>
<xs:enumeration value="InformationRegion"/>
<xs:enumeration value="NavigationRegion"/>
<xs:enumeration value="ComparisonRegion"/>
<xs:enumeration value="ScreenBannerRegion"/>
<xs:enumeration value="ScrollBarRegion"/>
<xs:enumeration value="PanelRegion"/>
<xs:enumeration value="PanelTabBackgroundRegion"/>
<xs:enumeration value="PanelOpenCloseRegion"/>
<xs:enumeration value="PalletteRegion"/>
<xs:enumeration value="PalletteSubmenuRegion"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="version_type">
<xs:pattern value="[0-9]{1,3}((\.[0-9]{1,3})\.[0-9]{1,4})"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="color_spec">
<xs:pattern value="#[0-9a-fA-F]{1,8}|[A-Z][A-Za-z]{1,25}"/>
</xs:restriction>
</xs:simpleType>
<xs:attributeGroup name="color_spec_attrs">
<xs:attribute name="value" type="color_spec" use="optional" />
</xs:attributeGroup>
<xs:attributeGroup name="color_quad_attrs">
<xs:attribute name="a" type="xs:unsignedByte"
<xs:attribute name="r" type="xs:unsignedByte"
<xs:attribute name="g" type="xs:unsignedByte"
<xs:attribute name="b" type="xs:unsignedByte"
<xs:complexType name="background_fill_type">
<xs:attributeGroup ref="color_spec_attrs"/>
<xs:attributeGroup ref="color_quad_attrs"/>
use="optional"
use="optional"
use="optional"
use="optional"
default="255"/>
/>
/>
/>
</xs:complexType>
<xs:complexType name="background_image_type">
<xs:attribute name="value" type="xs:string" use="required" />
<xs:attribute name="stretch-x" type="xs:boolean" use="optional" />
<xs:attribute name="stretch-y" type="xs:boolean" use="optional" />
</xs:complexType>
<xs:complexType name="background_symbol_type">
<xs:attribute name="value" type="xs:unsignedInt" use="required" />
<xs:attribute name="stretch-x" type="xs:boolean" use="optional" />
<xs:attribute name="stretch-y" type="xs:boolean" use="optional" />
</xs:complexType>
<xs:complexType name="region_type">
<xs:choice minOccurs="1" maxOccurs="1">
<xs:element name="background-fill" type="background_fill_type"/>
<xs:element name="background-image" type="background_image_type"/>
<xs:element name="background-symbol" type="background_symbol_type"/>
</xs:choice>
<xs:attribute name="name" type="region_decl" use="required" />
<xs:attribute name="dark" type="xs:boolean" use="optional" />
<xs:attribute name="foreground" type="color_spec" use="optional" />
<xs:attributeGroup ref="color_quad_attrs"/>
</xs:complexType>
<xs:complexType name="region_collection_type">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="11" name="region"
type="region_type"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="theme_type">
<xs:sequence>
<xs:element maxOccurs="1" name="regions" type="region_collection_type"/>
</xs:sequence>
<xs:attribute name="name" type="xs:string" use="required" />
<xs:attribute name="schema-version" type="version_type" use="required" />
<xs:attribute name="locale" type="xs:string" use="required" />
<xs:attribute name="created" type="xs:dateTime" use="optional" />
<xs:attribute name="modified" type="xs:dateTime" use="optional" />
</xs:complexType>
<xs:element name="theme" type="theme_type"/>
</xs:schema>
Example Document
This example, adapted from one of the systems built-in themes, illustrates the various options for encoding
the background element.

<theme
name="Black"
locale="en-US"
created="2010-09-08T18:06:53Z"
modified="2010-09-08T18:06:53Z"
xmlns="http://schemas.infograph.com/igc-brava-theme.xsd"
>
<regions>
<region name="TaskRegion" dark="true" foreground="#ffffffff">
</region>
<region name="InformationRegion" dark="false" foreground="#ffffffff">
<background-image value="c:\source\bravaXviewers9p0\image.png"/>
</region>
<region name="NavigationRegion" dark="true" foreground="#ffffffff">
</region>
<region name="ComparisonRegion" dark="true" foreground="#ff000000">
<background-fill value="Red"/>
</region>
<region name="ScreenBannerRegion" dark="false" foreground="#ff000000">
</region>
<region name="ScrollBarRegion" dark="true" foreground="#ffffffff">
<background-fill value="#ff585858"/>
</region>
<region name="PanelRegion" dark="true" foreground="#ff000000">
<background-image value="%userprofile%\igc\images\brand.png"/>
</region>
<region name="PanelTabBackgroundRegion" dark="false" foreground="#ffffffff">
<background-image
value="http://www.infograph.com/images/logo_igc_home.gif"/>
</region>
<region name="PanelOpenCloseRegion" dark="true" foreground="#ffffffff">
</region>
<region name="PalletteRegion" dark="true" a="255" r="255" g="255" b="255">
<background-fill a="255" r="128" g="128" b="128"/>
</region>
<region name="PalletteSubmenuRegion" dark="true" foreground="#ff51b3d3">
<background-fill value="#ff585858"/>
</region>
</regions>
</theme>
Extension
Figure 4. Extension Class Taxonomy
Xml Schema
<xs:schema
targetNamespace="http://schemas.infograph.com/igc-brava-extension.xsd"
xmlns="http://schemas.infograph.com/igc-brava-extension.xsd"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:pattern value="[0-9]{1,3}((\.[0-9]{1,3})\.[0-9]{1,4})"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="alignment_type">
<xs:enumeration value="left"/>
<xs:enumeration value="center"/>
<xs:enumeration value="right"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="drop_down_behavior_type">
<xs:enumeration value="standard"/>
<xs:enumeration value="split"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="xctrl_id_type">
<xs:restriction base="xs:unsignedInt">
<xs:minInclusive value="500000" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="xctrl_id_ref_type">
<xs:restriction base="xs:unsignedInt"/>
</xs:simpleType>
<xs:simpleType name="arrow_direction_type">
<xs:enumeration value="down"/>
<xs:enumeration value="right"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="container_decl">
<xs:enumeration value="TaskBar"/>
<xs:enumeration value="InformationBar"/>
<xs:enumeration value="MarkupProperties"/>
<xs:enumeration value="TextSearch"/>
<xs:enumeration value="MeasurementResults"/>
<xs:enumeration value="NavigationBar"/>
<xs:enumeration value="ComparisonBar"/>
<xs:enumeration value="ScreenBanner"/>
<xs:enumeration value="HorizontalScrollBar"/>
<xs:enumeration value="VerifyPanel"/>
<xs:enumeration value="ThumbnailPanel"/>
<xs:enumeration value="ChangemarkPanel"/>
<xs:enumeration value="MeasurePanel"/>
<xs:enumeration value="BookmarkPanel"/>
<xs:enumeration value="PanelTabBackground"/>
<xs:enumeration value="PanelOpenCloseBar"/>
<xs:enumeration value="MarkupTools"/>
<xs:enumeration value="RedactionTools"/>
<xs:enumeration value="MeasurementTools"/>
<xs:enumeration value="TakeoffTools"/>
<xs:enumeration value="PalletteSubmenu"/>
</xs:restriction>
</xs:simpleType>
<xs:attributeGroup name="padding_single_attrs">
<xs:attribute name="value" type="xs:integer" use="optional"/>
<xs:attributeGroup name="padding_articulated_attrs">
<xs:attribute name="top" type="xs:integer" use="optional"/>
<xs:attribute name="left" type="xs:integer" use="optional"/>
<xs:attribute name="right" type="xs:integer" use="optional"/>
<xs:attribute name="bottom" type="xs:integer" use="optional"/>
<xs:complexType name="padding_type">
<xs:attributeGroup ref="padding_single_attrs"/>
<xs:attributeGroup ref="padding_articulated_attrs"/>
</xs:complexType>
<xs:complexType name="image_type_weak">
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute name="value" type="xs:string" use="optional"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
<xs:simpleType name="image_type_strict">
<xs:minLength value="1"/>
<xs:maxLength value="260"/>
<xs:pattern value="[^\*?<>\|]+"/>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="empty_type"/>
<xs:complexType name="menu_text_type">
<xs:all minOccurs="0">
<xs:element minOccurs="0" maxOccurs="1" name="image"
type="image_type_strict"/>
</xs:all>
<xs:attribute name="xid" type="xctrl_id_type" use="required" />
<xs:attribute name="label" type="xs:string" use="optional" />
</xs:complexType>
<xs:complexType name="menu_type">
<xs:sequence>
<xs:choice minOccurs="1" maxOccurs="unbounded">
<xs:element name="menu-separator" type="empty_type"/>
<xs:element name="menu-text" type="menu_text_type"/>
</xs:choice>
</xs:sequence>
</xs:complexType>
<xs:complexType name="button_type">
<xs:element minOccurs="0" maxOccurs="1" name="image-dark"
type="image_type_weak"/>
<xs:element minOccurs="0" maxOccurs="1" name="image-light"
type="image_type_weak"/>
<xs:element minOccurs="0" maxOccurs="1" name="padding"
type="padding_type"/>
</xs:all>
<xs:attribute name="label" type="xs:string" use="optional" />
<xs:attribute name="tooltip" type="xs:string" use="optional" />
</xs:complexType>
<xs:complexType name="drop_down_button_type">
<xs:complexContent>
<xs:extension base="button_type">
<xs:attribute name="drop-down" type="drop_down_behavior_type"
use="required" />
<xs:attribute name="arrow-direction" type="arrow_direction_type"
use="optional" default="down"/>
<xs:attribute name="delegate-xid" type="xctrl_id_ref_type"

use="optional"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="placement_fixed_type">
<xs:attribute name="x" type="xs:integer" use="optional" default="0"/>
<xs:attribute name="y" type="xs:integer" use="optional" default="0"/>
</xs:complexType>
<xs:complexType name="placement_relative_type">
<xs:attribute name="alignment" type="alignment_type" use="optional"
default="left"/>
</xs:complexType>
<xs:complexType name="placement_ordered_type">
<xs:attribute name="pivot-xid" type="xctrl_id_ref_type" use="required" />
<xs:attribute name="pre-order" type="xs:boolean" use="optional"
default="true"/>
</xs:complexType>
<xs:complexType name="container_type">
<xs:sequence>
<xs:element name="placement-fixed" type="placement_fixed_type"/>
<xs:element name="placement-relative" type="placement_relative_type"/>
<xs:element name="placement-ordered" type="placement_ordered_type"/>
</xs:choice>
</xs:sequence>
<xs:attribute name="name" type="container_decl" use="required" />
</xs:complexType>
<xs:complexType name="control_collection_type">
<xs:sequence>
<xs:element name="button" type="button_type"/>
<xs:element name="drop-down-button" type="drop_down_button_type"/>
<xs:element name="menu" type="menu_type"/>
</xs:choice>
</xs:sequence>
</xs:complexType>
<xs:complexType name="layout_type">
<xs:sequence>
<xs:element maxOccurs="21" name="container" type="container_type"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="extension_type">
<xs:sequence>
<xs:element maxOccurs="1" name="controls" type="control_collection_type"/>
<xs:element maxOccurs="1" name="layout" type="layout_type"/>
</xs:sequence>
</xs:complexType>
<xs:element name="extension" type="extension_type"/>
</xs:schema>
Example Document
This example, adapted from the Redact-It Desktop command file, depicts the separation of layout
(placement) from control definition.
<?xml version="1.0" encoding="UTF-8"?>

<extension
locale="en-US"
created="2010-09-27T21:28:43Z"
modified="2010-09-27T21:28:43Z"
xmlns="http://schemas.infograph.com/igc-brava-extension.xsd"
>
<controls>
<button xid="500000" label="Open" tooltip="Open a File"/>
<drop-down-button xid="500003" label="Apply" tooltip="Apply Markup" dropdown="split" arrow-direction="down">
</drop-down-button>
<drop-down-button xid="500004" label="Verify" tooltip="Verify Redactups"
drop-down="split" arrow-direction="down">
<padding left="13" bottom="4" right="6"/>
</drop-down-button>
<drop-down-button xid="500005" label="Finalize" tooltip="Finalize Document"
drop-down="split" arrow-direction="down" delegate-xid="520000"/>
<button xid="5000001" tooltip="Previous File">
<image-dark>c:\source\bravaXviewers9p0\image_d.png</image-dark>
<image-light>c:\source\bravaXviewers9p0\image_l.png</image-light>
</button>
<button xid="5000002" tooltip="Next File">
<image-dark value="http://www.infograph.com/images/next_file_d.png"/>
<image-light value="http://www.infograph.com/images/next_file_l.png"/>
</button>
<menu xid="520000">
<menu-text xid="520001" label="Publish to PDF...\tCtrl+Shift+D"/>
<menu-text xid="520002" label="Publish to TIFF...\tCtrl+Shift+T"/>
<menu-text xid="520003" label="Publish to CSF...\tCtrl+Shift+K"/>
<menu-separator/>
<menu-text xid="520004" label="Set Watermark/Banners"/>
<menu-text xid="520005" label="Set Bates Number"/>
<menu-separator/>
<menu-text xid="520006" label="View Redaction Log">
<image>http://www.libpng.org/pub/png/PngSuite/bgyn6a16.png</image>
</menu-text>
<menu-separator/>
</menu>
</controls>
<layout>
<placement-fixed xid="500000" x="100" y="100"/>
<placement-relative xid="500001" alignment="left"/>
<placement-relative xid="500002" alignment="center"/>

<placement-ordered xid="500004" pivot-xid="500002" pre-order="false"/>
</container>
</layout>
</extension>
Text Selection
Xml Schema
<xs:schema
targetNamespace="http://schemas.infograph.com/igc-cdl-text-selection.xsd"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
>
<xs:pattern value="[0-9]{1,3}((\.[0-9]{1,3})\.[0-9]{1,4})"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="colorref_spec_type">
<xs:pattern value="\#[0-9a-fA-F]{2,6}" />
</xs:restriction>
</xs:simpleType>
<xs:attributeGroup name="range_extent_attrs">
<xs:attribute name="index" type="xs:unsignedShort" use="required"/>
<xs:attribute name="len" type="xs:unsignedShort" use="required"/>
<xs:simpleType name="page_number_type">
<xs:restriction base="xs:unsignedInt">
<xs:minInclusive value="1" />
</xs:restriction>
</xs:simpleType>
<xs:complexType name="range_type">
<xs:attributeGroup ref="range_extent_attrs"/>
<xs:attribute name="page" type="page_number_type" use="optional"/>
</xs:complexType>
<xs:complexType name="selection_type">
<xs:element minOccurs="1" maxOccurs="1" name="range" type="range_type"/>
<xs:element minOccurs="0" maxOccurs="1" name="content" type="xs:string"/>
</xs:all>
<xs:attribute name="color" type="colorref_spec_type" use="optional"/>
</xs:complexType>
<xs:complexType name="selection_group_type">
<xs:sequence minOccurs="0">
<xs:element minOccurs="0" maxOccurs="unbounded" name="selection"

type="selection_type"/>
</xs:sequence>
<xs:attribute name="default-color" type="colorref_spec_type" use="required"/>
<xs:attribute name="collation" type="version_type" use="required" />
</xs:complexType>
<xs:element name="selections" type="selection_group_type"/>
</xs:schema>
Example Document
<selections
collation="4.0.0"
default-color="#000000"
locale="en-US"
created="2011-08-31T18:56:30.769Z"
modified="2011-08-31T18:56:30.769Z"
>
<content>Law</content>
</selection>
<selection>
<range index="449" len="8"/>
<content>criminal</content>
</selection>
<content>Rule</content>
</selection>
</selections>

BravaExtensibleInterface UserGuide

Enviado por

Dados do documento

Título original

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

BravaExtensibleInterface UserGuide

Enviado por

Direitos autorais:

Formatos disponíveis

Brava!

Product Version Information

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

When DataSource == 1, the argument is interpreted as an Xml-encoded string. When

Indicates the type of the ColorData argument where:

<?xml version="1.0" encoding="utf-8"?>

Informative Graphics Corporation

July 16, 2013, Revision 2.0

<region name="CompareRegion" dark="true" foreground="#ffffffff">

A single, solid fill color.

An image read from a file or URL.

An image stored as an embedded resource with resource identifier N.

A background constructed from an internal resource identifier is depicted below

<region name="TaskRegion" dark="true" value="#ffffffff">

July 16, 2013, Revision 2.0

For additional information, refer to Appendix A: Identifiers Regions.

Informative Graphics Corporation

July 16, 2013, Revision 2.0

<background-fill value="#ffffffff" />

<background-fill value="White" />

<background-image value="http://tiny.com/a.png" />

<background-image value="c:\images\a.png" />

<background-image value="%userprofile%\data\a.png" />

Informative Graphics Corporation

July 16, 2013, Revision 2.0

<background-symbol value="2907" />

Informative Graphics Corporation

July 16, 2013, Revision 2.0

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

Indicates the type of the ButtonData argument where:

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

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

HRESULT GetCtrlScreenCoordinate([in] int CtrlID, [in] int TargetPos, [out,

HRESULT CustomButtonInvoked(long ButtonID);

<?xml version="1.0" encoding="UTF-8"?>

July 16, 2013, Revision 2.0

<button xid="500003" drop-down="split" direction="down" label="Apply"

Informative Graphics Corporation

July 16, 2013, Revision 2.0

<image-dark value="http://tiny.com/a.png" />

July 16, 2013, Revision 2.0

<image-light value="http://tiny.com/a_l.png" />

The drop-down arrow points downward.

The drop-down arrow points to the right.

Informative Graphics Corporation

July 16, 2013, Revision 2.0

Informative Graphics Corporation

July 16, 2013, Revision 2.0

Position the control at a fixed point within the container.

July 16, 2013, Revision 2.0

Center the control within the container.

Right justify the control within the container.

Informative Graphics Corporation

July 16, 2013, Revision 2.0

The control should appear before the pivot control.

The control should appear after the pivot control.

Informative Graphics Corporation

July 16, 2013, Revision 2.0

Text Selection (External Search)

TextSel_GetPageText([in] int Page, [out,retval] BSTR* Content);

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

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

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