| CATEGORII DOCUMENTE |
| Bulgara | Ceha slovaca | Croata | Engleza | Estona | Finlandeza | Franceza |
| Germana | Italiana | Letona | Lituaniana | Maghiara | Olandeza | Poloneza |
| Sarba | Slovena | Spaniola | Suedeza | Turca | Ucraineana |
ActiveX Control Interface Details
This document provides brief descriptions of the properties, methods, and events used to interface with the Brava! Desktop ActiveX control, version 2.1.
Contents:
AllowPageChangeOnDocumentScroll
PaperSpaceWidth and PaperSpaceHeight
UseCurrentWindowsDefaultPtinter
NumberEditableIntegrationMarkups
TakeOwnershipOnMarkupConsolidation
User Interface Customization Section
InvokeCustomerIntegrationMethod
SaveViewAs/ Burn-in/ Publish Section
Collaboration Interface Section
External Reference File Section
RequestOpenMarkupStampTemplate
RequestSaveMarkupStampTemplate
RequestSaveAsMarkupStampTemplate
RequestCloseMarkupStampTemplate
MarkupStampTemplateLoadFailure
MarkupStampTemplateLoadSuccess
MarkupStampTemplateLoadSuccess
RequestMarkupStampEntityFilename
RequestLocalFilenameForDownloadOriginal
Control Identification Section
Banner and watermark menu items
Markup Text Background Options menu items
The control will provide all file input and output user interface (e.g., File Open dialog, Save As dialog) unless the following property is set.
Boolean. Used to get/set the controls method of prompting the user for file IO. If set to TRUE, the control will fire an event to indicate that it is requesting a file to be opened, closed, or saved. See Events Section. The default value is FALSE.
Example:
RequestFileIOEvents=FALSE.
String. Used to get/set the file currently being viewed.
Example:
viewObject.Filename = 'C:/files/somefile.csf' // causes the control to attempt to load
// the indicated file.
String. Used to get/set the markup file currently being read-only viewed. Because multiple read-only markups can be opened, this property is an asterisk delimited list of filenames.
Example:
viewObject.MrkReviewFilename = 'C:/files/somefile.xrl' // causes the control to
// attempt to load the indicated
//un-editable markup file.
String. Used to get/set the markup file currently being viewed. Markup files opened for edit can only be opened one at a time. Setting this property while there is currently an editable markup file open will cause the current markup file to close.
Example:
viewObject.MrkEditFilename = 'C:/files/somefile.xrl' // causes the control to
// attempt to load the indicated
// markup file.
Boolean. Used to get/set the controls ability to allow files to be dragged and dropped in to its client area for opening. Default is true.
Boolean. This property will be FALSE if the currently viewed file has not yet completed publishing on the Brava server.
CloseFile()
This method closes the file currently being viewed. Also closes any currently open markup files.
OpenMarkupReview(BSTR filename)
This method causes the control to attempt to open a markup review file indicated by BSTR fileName.
CloseAllMarkupReview()
This method causes all markup review files currently open to be closed.
CloseMarkupReview(int index)
This method causes the control to close a particular markup review file indicated by the integer index. Markup review files are indexed in the order in which they were opened, with the first having an index of zero. If there are two or more review markup files currently open, and an index of -1 is passed to CloseMarkupReview, the control will display a modal dialog from which the user can select the markup or markups to be closed.
NewMarkup()
This method causes the control to create a new un-named editable markup.
OpenMarkupEdit(BSTR fileName)
This method causes the control to open an existing editable markup file. If there is currently an editable markup open, this editable markup file will be closed.
SaveMarkup()
This method causes the control to save all changes to the currently open editable markup. If the currently open markup has not been previously saved, the control will prompt for a file name using one of the methods described in the File IO Option Section.
SaveAsMarkupEdit(BSTR fileName)
This method causes the control to save the current state of the currently open editable markup. The markup will be saved in the file indicated by the file name.
CloseMarkupEdit()
This method causes any editable markup file currently open to be closed.
([in] BSTR LocalFileName)
If the currently viewed drawing or document is remote, this method copies that file to the path and filename defined in LocalFileName.
Any method or property that causes the control to create a file can not be accessed through HTML scripting languages. This includes the following:
SaveAsMarkupEdit
SaveAsMarkupStampTemplate
SaveAsMarkupEditDXF
SaveViewAs
SaveViewAsEx
DownloadOriginalToLocalFile
ExportPDF
ExportPDFEx
ExportTiff
ExportTiffEx
ExportDWF
ExportCSF
ExportCSFSilent
All interaction between the view and the user's mouse is controlled by changing the property MouseTool.
Short(integer). Used to get/set the currently active mouse tool. The following are acceptable values:
MT_SOURCEDOC_SELECT = 1
MT_PAN = 2
MT_ZOOM = 3
MT_ROTATE = 4
MT_MAGNIFIER = 5
MT_CALIBRATE = 6
MT_MEASURE_LINE = 7
MT_MEASURE_POLYGON = 8
MT_MEASURE_RECT = 9
MT_REDLINE_EDIT = 10
MT_REDLINE_SKETCH = 11
MT_REDLINE_POLYGON = 12
MT_REDLINE_TEXT = 13
MT_REDLINE_ELLIPSE = 14
MT_REDLINE_ARC = 15
MT_REDLINE_RECTANGLE = 16
MT_REDLINE_POLYLINE = 17
MT_REDLINE_LINE = 18
MT_REDLINE_ARROW = 19
MT_REDLINE_SKETCHPOLYGON = 20
MT_REDLINE_XOUT = 21
MT_REDLINE_XOUT_TEXT = 22
MT_REDLINE_UNDERLINE_TEXT = 23
MT_REDLINE_HIGHLIGHT_TEXT = 24
MT_REDLINE_CHANGEMARK = 25
MT_REDLINE_POLYCLOUD = 26
MT_REDLINE_RECTCLOUD = 27
MT_REDLINE_RASTER = 28
MT_PRINTREGION = 29
MT_DYNAMIC_ZOOM = 30
MT_REDLINE_SQUIGLE_RECT = 31
MT_MEASURE_COUNT = 32
MT_REDLINE_BLOCKOUT = 33
MT_ALIGN_COMPARE_DOCS = 34
MT_MEASURE_POLYLINE = 35
MT_COPYREGION = 36
MT_MEASURE_CIRCLE = 37
MT_REDLINE_STAMP = 38
MT_REDLINE_PEEKTHROUGH = 40
CopySelection()
If the currently active mouse tool is MT_SOURCEDOC_SELECT and a section of the document or drawings text is selected, this method copies the selected text into the system clipboard.
Boolean. This property is used to get/set whether or not the current view is drawn as monochrome.
Example:
viewObject.Monochrome = 1 // causes the current view to be displayed
// only in black and white.
Short(integer). This property is used to get/set the background color of the current view. The following are acceptable values:
0 = BK_DEFAULT
1 = BK_BLACK
2 = BK_WHITE
3 = BK_GRAY
Example:
viewObject.BackgroundColor = 2 // causes the current view to be displayed with
// a white background.
Boolean. This property is used to get/set whether the control displays the about splash screen.
Example:
viewObject.ShowAbout = 1 // causes the About splash screen to be displayed.
Boolean. This property is used to get/set whether the control animates between view states.
Example:
viewObject.EnableAnimation = 0 // disable animation.
Long(integer). Used to get/set the amount of time the control will allow for any animation between view states. This property is measured in milliseconds.
Example:
viewObject.AnimationTime = 0 // disable animation.
viewObject.AnimationTime = 1000 // only allow animations that can be completed in
// 1 or less seconds.
Boolean. This property is used to get/set whether the control is allowed to trade image quality for draw speed during panning or zooming. When the pan or zoom manipulation is complete, the control will always draw at full quality.
Example:
viewObject.EnableQuickDraw = 0 // always draw at full image quality.
Boolean. This property is used to get/set whether the control displays file load and page change status. The status text appears in the lower left corner of the control.
Example:
viewObject.DisplayLoadStatus = 1 // display status during file loads and page changes.
Boolean. This property is used to get/set whether the control uses anti-aliasing to draw vector lines.
Example:
viewObject.EnhancedRenderMode = 0 // make all vector lines draw anti-aliased.
Boolean (Read-only). This property is used to determine if the control has the necessary system dlls to render in enhanced mode.
Boolean. This property gets and sets the visibility state of the thumbnail panel.
Integer. This property gets and sets the display size for individual thumbnails in the thumbnail panel. Valid range is 20 to 185.
String. When this property is set, the control will search for the given text. Note that the currently open drawing or document must contain searchable text.
String. When this property is set, the control will display the given text in the tool information area. By default, this area displays the filename of the currently open document or drawing.
String. The control will use this property whenever it needs to determine the current user name. By default, the control queries the user name from the operating system. For example, if the UserName property is set to NewUser1 any markup entities subsequently created will use NewUser1 as the author name.
String. The control will use this property whenever it needs to determine the format of the date display. Date strings can be displayed in markup entity information, Changemark information, and banners/watermarks. The following are valid tokens for DateFormat:
|
%a |
Abbreviated weekday name |
|
%A |
Full weekday name |
|
%b |
Abbreviated month name |
|
%B |
Full month name |
|
%c |
Date and time representation appropriate for locale (This is the default) |
|
%d |
Day of month as decimal number (01 - 31) |
|
%H |
Hour in 24-hour format (00 - 23) |
|
%I |
Hour in 12-hour format (01 - 12) |
|
%j |
Day of year as decimal number (001 - 366) |
|
%m |
Month as decimal number (01 - 12) |
|
%M |
Minute as decimal number (00 - 59) |
|
%p |
Current locale's A.M./P.M. indicator for 12-hour clock |
|
%S |
Second as decimal number (00 - 59) |
|
%U |
Week of year as decimal number, with Sunday as first day of week (00 - 53) |
|
%w |
Weekday as decimal number (0 - 6; Sunday is 0) |
|
%W |
Week of year as decimal number, with Monday as first day of week (00 - 53) |
|
%x |
Date representation for current locale |
|
%X |
Time representation for current locale |
|
%y |
Year without century, as decimal number (00 - 99) |
|
%Y |
Year with century, as decimal number |
|
%z, %Z |
Either the time-zone name or time zone abbreviation |
|
%% |
Percent sign |
String. The control will use this property whenever it needs to determine the proper time zone for date display and adjusting the current system time. The TimeZone property can be specified as follows:
TimeZone = tzn[+ | -]hh[:mm[:ss] ][dzn]
|
tzn |
Three-letter time-zone name, such as PST. You must specify the correct offset from local time to UTC. |
|
hh |
Difference in hours between UTC and local time. Optionally signed. |
|
mm |
Minutes. Separated from hh by a colon (:). |
|
ss |
Seconds. Separated from mm by a colon (:). |
|
dzn |
Three-letter daylight-saving-time zone such as PDT. If daylight saving time is never in effect in the locality, set TimeZone without a value for dzn. |
Boolean. If set to FALSE, the control will draw all vector lines with a width of 1 pixel. Default is TRUE.
Boolean. If set to TRUE, causes the control to maintain the current view at extents during window resizing. Default is TRUE.
Boolean. If set to TRUE and a document is currently viewed, this property causes the vertical scroll bar and mouse wheel to change pages when the end or beginning of a page is reached. Default is TRUE. Note that this feature only applies to documents and not drawings.
Boolean. (Read-only) If set to TRUE, this property indicates that one or more pages in the current document or drawing have been rotated from their original orientation.
ShowLayerInfo()
This method causes the control to display a modal dialog allowing the user to view and manipulate a drawings layers.
Rotate90()
This method causes the control to rotate the current view 90 degrees clockwise.
Rotate90Counterclockwise()
This method causes the control to rotate the current view 90 degrees counter-clockwise.
FitAll()
This method causes the control to adjust the view so that all drawing elements fit into the visible area.
FitWidth()
This method causes the control to adjust the view so that the entire width of the document/drawing fits into the visible area.
MirrorRaster(BOOL Horizontal, int Page)
This method causes the control to mirror a raster document or drawing. Parameter Page is used to indicate which page of a multi-page document or drawing to mirror. If the parameter Horizontal is TRUE, the mirroring will be done about the Y (up and down) axis. If the parameter Horizontal is FALSE, the mirroring will be done about the X (left to right) axis.
GetCurrentViewportState(double *EyeX, double *EyeY, double *Width, double *Height, double *Rotation, int CoordSys)
This method retrieves the current viewport values relative to the extents of the document/drawing. EyeX and EyeY are the x and y values of the center of the view. Width and Height indicate scale or zoom level. Rotation is measured in degrees. CoordSys governs the coordinate system used as follows.
BRAVAX_WORLD = 0
If CoordSys is set to 0, the real values returned by GetCurrentViewportState will be in the drawing/documents native units.
BRAVAX_ABSOLUTE_SCALE = 1
If CoordSys is set to 1, the EyeX and EyeY returned by GetCurrentViewportState will be in the drawing/documents native units. Width will be the scale value required to convert EyeX and EyeY into device space. Height is ignored.
BRAVAX_NDC = 2
If CoordSys is set to 2, the real values returned by GetCurrentViewportState will be in normalized device coordinates.
SetCurrentViewportState(double EyeX, double EyeY, double Width, double Height, double Rotation, int CoordSys)
This method changes the current viewport state relative to the extents of the document/drawing. EyeX and EyeY are the x and y values of the center of the view. Width and Height indicate scale or zoom level. Rotation is measured in degrees. CoordSys governs the coordinate system used as follows:
BRAVAX_WORLD = 0
If CoordSys is set to 0, the real values used by SetCurrentViewportState will be in the drawing/documents native units.
BRAVAX_ABSOLUTE_SCALE = 1
If CoordSys is set to 1, the EyeX and EyeY used by SetCurrentViewportState will be in the drawing/documents native units. Width will be the scale value required to convert EyeX and EyeY into device space. Height is ignored.
BRAVAX_NDC = 2
If CoordSys is set to 2, the real values used by SetCurrentViewportState will be in normalized device coordinates.
CopyPageTextToClipboard()
This method extracts all of the text from the currently viewed page and inserts it into the Windows clipboard.
([in] int PageNumber,
[out] double *ToInchesScale,
[out] double *Width,
[out] double *Heigh,
[out] BOOL *IsSingleRaster,
[out] int *SingleRasterDPI,
[out] BOOL *IsMonochromeRaster,
[out] BSTR *PageName,
[out] BSTR *PageMetaData)
This method retrieves information about a particular page in a currently loaded document or drawing.
PageNumber = page to get information about
ToInchesScale = scale value used to convert native Width and Height unit to inches
Width = width in native units
Height = height in native units
IsSingleRaster = if returned TRUE, the page is composed entirely of one raster entity
SingleRasterDPI = if IsSingleRaster is TRUE, this value is the dots per inch of the raster entity.
IsMonochromeRaster = if IsSingleRaster is TRUE, this value indicates if raster is monochrome or color
PageName = page name
PageMetaData = not currently used
([in] long DevX,
[out] long DevY,
[out] double *WorldX,
[out] double *WorldY)
This method is used to determine a document/drawing specific point that corresponds to a device/screen point.
DevX and DevY are in screen/pixel coordinates relative to the top-left corner of the control document view area.
Example
Document X is a D size drawing with dimensions of 36in x 24in.
The controls document view area is 300 pixels x 200 pixels.
The current view of Document X is centered within the controls viewport.
Call GetWorldSpacePoint with DevX=150 and DevY=100.
Values for WorldX and WorldY will be returned as 18 and 22.
([in] double ScaleValue)
This method allows the current view to be scaled to inches. To scale the view to 100%,
a ScaleValue of 1.0 would be used. A ScaleValue of 0.5 would cause the current view to be scaled to 50%.
([out] double *ScaleValue)
This method retrieves the current scale value.
([in] BSTR SearchString,
[in] BOOL SearchForward,
[in] BOOL MatchCase,
[in] short SearchPosition,
[in] BSTR SearchParams,
[out, retval] short *Result)
This method causes the control to search for and highlight text within the currently loaded document or drawing.
SearchString =- string to find
SearchForward = If set to TRUE, the control will search forward. If set to FALSE, the control will search backward.
MatchCase = if set to TRUE, the control will do a case-sensitive search
SearchPosition = indicates where (within the document or drawing) to do the search.
Possible values
SPT_FROMBEGINING = 1
SPT_FROM_CURRENT = 2
SPT_FROMEND = 3
SearchParams = not currently used.
Result = used to return the result of the search.
Possible values:
SRT_FULLFAIL = 1 - means SearchString was not found anywhere in the document or drawing.
SRT_PARTFAIL = 2 - means SearchString was not found between the current search position and end of the docuemt if SearchForward = TRUE, or not found between the current search position and the beginning of the document if SearchForward = FALSE.
SRT_SUCCESS = 3 - means SearchString was found and highlighted between the current search position and end of the document if SearchForward = TRUE, or found and highlighted between the current search position and the beginning of the document if SearchForward = FALSE.
View Pins are a means of setting a marker at particular position/viewstate within a document/drawing.
The control can store a list of View Pin that exists for the duration of a single file load.
Integer. Read Only. This property indicates the number of View Pins currently stored.
([out] int *NumPins, [out] int *CurrentPinIndex)
Retrieves the total number of View Pins in the current list and the index of the last viewed View Pin (current View Pin index).
AddViewPin()
This method adds a new View Pin marker to the list.
NextViewPin()
This method increments the current View Pin index and changes the view to that pin.
PreviousViewPin()
This method decrements the current View Pin index and changes the view to that pin.
GoToViewPin([in] int PinIndex)
This method sets the current View Pin index to PinIndex and changes the view to that in.
ClearViewPins()
This method deletes the entire View Pin list.
The control has the ability to navigate 'Back' and 'Forward' during viewing session.
The current viewstate consists of:
Zoom level
Pan location
Rotation
Page number
Compare view mode
A new viewstate is added to the viewstate stack when:
Zoom level changes
Rotation changes
Page number changes
Compare view mode changes
A new viewstate is NOT added when pan location changes. However, two new viewstates are added at the point of a normal viewstate change if the pan location has changed since the addition of the last saved viewstate. First the current state with the changed pan location is added then the new normal viewstate.
Example 1:
Load multi-page (4 or more pages) document
Hit page down 3 times
Press Ctrl + Alt + Left Arrow (back) 3 times
1st back goes to top of page 3
2nd back goes to top of page 2
3rd back goes to top of page 1 (starting view)
Example 2:
Load multi-page (4 or more pages) document
Scroll the view until the fourth page is visible
Press Ctrl + Alt + Left Arrow (back) 3 times
1st back goes to bottom of page 3
2nd back goes to top of page 3
3rd back goes to bottom of page 2
Boolean. If set to FALSE, the control will not save viewstates.
Defaults to TRUE.
BackView()
This method sends the viewstate back one state.
ForwardView()
This method sends the viewstate forward one state.
([out] int *NumViewStates, [out] int *CurrentViewStateIndex)
The method retrieves the number of viewstates that have been auto-saved and the current index in the saved viewstate stack.
Short(integer). This property is used to get/set the page of a multi-page document currently being viewed. The first page of a multi-page document is indexed as 1.
Example:
viewObject.CurrentPageNumber = 106 // causes the control to display page 106.
Short(integer). Read Only. This property is used to get the total number of pages in the currently viewed multi-page document.
Example:
viewObject.CurrentPageNumber = viewObject.TotalPages - 1 // causes the control to
//display the second to the last page.
NextPage()
This method causes the control to load and view the next page of a multi-page document or drawing. If the control is currently viewing the last page of a multi-page document of drawing, NextPage does nothing.
PreviousPage()
This method causes the control to load and view the previous page of a multi-page document or drawing. If the control is currently viewing the first page of a multi-page document of drawing, PreviousPage does nothing.
Double(real). PaperSpaceWidth and PaperSpaceHeight provide the ability to establish paper space for format types that either do not have a paper space concept, or for display list files that are in non-modelspace: CGM, DWF, DGN, and the model page of DWG documents. Use this property to scale an image to a particular paper size. The renderer can then map the documents world space coordinates to real world coordinates. The values are measured in inches. The default is size D (22x36).
Example:
viewObject. PaperSpaceWidth = 22 // set paper size to D (22x36).
viewObject. PaperSpaceHeight = 36
String. This property provides the ability to establish paper space for format types that either do not have a paper space concept, or for display list files that are in non-modelspace: CGM, DWF, DGN, and the model page of DWG documents. Use this optional property to scale an image to a particular paper size. The renderer can then map the documents world space coordinates to real world coordinates. This value affects the zoom percentage and size of print banners relative to the overall size of the printed image.
Enter the paper size value as paper width, paper height, measurable units. Valid values for measurable units (indicating inches or meters) are i, I, m, or M
Example:
PaperViewSize=8.5,11,i
The last value (i or m) must be present in order to convert the first two fields to numbers. If not set, or if this property does not exist, the default value is 22,36,i indicating a paper size of 22 x 36 inches.
Integer. This property is used to get and set the density of the pattern used to draw the print watermark. A higher value causes the watermark to be more transparent, and a lower value causes the watermark to be more opaque. Valid values are:
0 = Opaque
1 = Dark (results in a large print spool size)
2 = Medium
3 = Light
Print()
Causes the control to display the print/print preview modal dialog.
This method will cause the control to display the print dialog. This method has the same effect as Method::Print.
PrintCurrentView()
This method causes the control to do a quick print of the current view. The print output will be directed to the currently selected printer or to the default printer if no printer has been selected.
PrintPageRange(int Start, int End)
This method causes the control to print from Start to End pages of a document or drawing. The print output will be directed to the currently selected printer or to the default printer if no printer has been selected.
UseCurrentWindowsDefaultPrinter()
This method forces the control to update its current printer to be the current Windows default printer. If the end user has changed the printer via the Brava Desktop Print dialog, this method will overrule those changes.
The following properties are string values used to get and set individual banner strings and watermarks. Positioned banners (e.g. TopLeft, RightCenter), can display up to ten separate lines. To indicate a line break use <n>. Any strings set via these properties will not be editable via the EditIsoBanners method.
ScreenBanner
ScreenWatermark
Watermark
TopLeft
TopCenter
TopRight
BottomLeft
BottomCenter
BottomRight
LeftTop
LeftCenter
LeftBottom
RightTop
RightCenter
RightBottom
Tags (macros) can be included in the copyright banner string (such as %time, %date, %dbstring(db_token_name), etc). The following macros are supported:
%Date or %Daydate Inserts the date (or day and date) the print was spooled. If the tags are viewed on screen, the time at which the screen was last refreshed displays.
%SysDatePlusDays(x) Inserts a date the specified number of days past the system date. Replace 'x' with the desired number of days. Negative numbers of days may be entered.
%DBString(x) This tag is used to resolve custom tags for products that integrate with Brava! Replace 'x' with any printable character except a right parenthesis, ')'. See notes below.
%Time Inserts the time the print was spooled based on a 12 hour clock (AM/PM). If the tags are viewed on screen, the date on which the screen was last refreshed displays.
%MilTime Inserts the time the print was spooled based on a 24 hour clock.
%Title Adds the name of the document.
%Page Adds the page number.
%TotalPages Inserts the total number of pages.
%Login (or %User) Specifies the user name of the person who issued the print.
%% Inserts a single % character.
Example:
The following string would put the current page number and current user name on the top center of each page printed through Brava! Desktop:
viewObject.TopCenter = 'Page Number %Page User Name %User'
String. This property is used to get/set the font name used to render all banner strings.
Example:
viewObject. WatermarkBannerFontName = Arial // all banner strings use Arial.
Short(integer). This property is used to get/set the font style used to render all banner strings. The following are acceptable values:
IFS_NORMAL = 0 (default)
IFS_BOLD = 1
IFS_ITALIC = 2
IFS_BOLDITALIC = 3
Example:
viewObject. WatermarkBannerFontStyle = 3 // all banner strings are bold and italic.
Boolean. If set to true, all banners and watermarks will be persisted from session to session. Defaults to false.
([in] BSTR Key,[in] BSTR Value)
This method can be used to allow the control container to provide a string value for any unresolved token within a banner or watermark. The token value is indicated by Key and the replacement will be set in Value.
([in] BSTR Key,[out,retval] BSTR Value)
This method is used to determine the replacement value for any custom token set by SetCustomBannerValue.
This method is will clear all custom banner values set by SetCustomBannerValue.
EditIsoBanners()
This method causes the control to display the ISO Banners and Watermark modal dialog.
Boolean. (Read Only) This property is used to get a Boolean value that indicates if the scale for measurement operations has been set. Measurement scale must be set via the MT_CALIBRATE tool prior to using any of the other measurement tools (exception is MT_MEASURE_COUNT). Calibration must be re-done every time a new document or drawing is opened. Note that after a calibration has been completed via the MT_CALIBRATE tool, the currently active mouse tool will be automatically set to MT_MEASURE_LINE. If this is not the desired behavior, a container must adjust after receiving the CalibrationComplete() event. See Events Section.
Example:
If(viewObject.CalibrationComplete) //Only set the measure line tool if
//calibration is complete
ShowMeasurementSettings()
Causes the control to display the modal measurement settings dialog.
Boolean. (Read Only) This property is used to get the number of currently open markup review files.
Integer. This property returns the total number of markups that are available through the integration dll.
Integer. This property returns the total number of editable markups that are available through the integration dll.
Boolean. Used to get/set whether the control displays the Changemarks review control.
Boolean (Read Only) If set to TRUE, the control currently has an editable markup file open.
Boolean (Read Only) If set to TRUE, the control has made changes to the currently open editable markup files that have not been saved.
Boolean. If set to TRUE, the control allows entities in the currently open editable markup to be transferred to the current user name. Markup entity ownership is changed by clicking on the entity while depressing the <Shift> key while the markup selection tool is active. Default is FALSE.
Boolean. If set to TRUE, the control transfers ownership of all markup entities during a consolidation of open markups. See method ConsolidateMarkups for details. Default is FALSE.
Boolean. If set to FALSE, the control will disable the user interface for changing the color of markup entities.
String. Used to set the current color of markup entities. The following are valid strings and their corresponding RGB value:
white = RGB(255,255,255)
yellow = RGB(255,255,0)
magenta = RGB(255,0,255)
red = RGB(255,0,0)
cyan = RGB(0,255,255)
green = RGB(0,255,0)
blue = RGB(0,0,255)
darkGrey = RGB(128,128,128)
grey = RGB(192,192,192)
olive = RGB(128,128,0)
purple = RGB(128,0,128)
maroon = RGB(128,0,0)
teal = RGB(0,128,128)
pine = RGB(0,128,0)
darkBlue = RGB(0,0,128)
black = RGB(0,0,0)
Boolean. If set to false, the control will not display a warning dialog if it is closing an unsaved markup.
String. Used to get/set the raster file used with the raster markup tool. The raster markup tool can use JPEG or PNG raster files.
Boolean (Read Only) If set to 0, redactions exist.
Redactions can be burned in to a CSF file or exist inside a markup that is open for edit or review.
Boolean (Read Only) If set to TRUE, the control currently has an editable markup stamp template file open.
Boolean (Read Only) If set to TRUE, the control has made changes to the currently open editable markup stamp template file that have not been saved.
String. Used to get/set the markup stamp template file to be used with the markup stamp tool.
GotoMarkupPage(int pgIterType)
This method loads a document or drawing page containing at least one markup entity. The value of int pgIterType controls which page containing a markup entity to open. The acceptable values for int pgIterType are:
IT_FIRST = 1
IT_NEXT = 2
IT_PREVIOUS = 3
IT_LAST = 4
This method makes the control display the Find and Redact dialog.
([in] BSTR RedactionScript,[out,retval] int *NumRedactions)
This method applies a redaction script file indicated by RedactionScript. The resulting number of redactions created is returned in NumRedactions.
([in] BSTR RedactionScript,[out,retval]BOOL *Valid)
This method is used to determine if a given text file is a valid redaction script. The full path to the file is provided in RedactionScript. If valid, the Boolean parameter Valid will be returned as true.
Boolean. (Read-only) If set to false, this method indicates that the current markup has redactions created but never burnt in to a new CSF file.
Boolean. (Read-only) If set to true, this method indicates that the current file viewed has markup burned in. Note that this only applies to a CSF file.
This method takes all of the entities in all of the markups that are open for review and places them in one editable markup. If there is not currently an editable markup open for review, this method creates a new editable markup.
([in] BSTR CMID, [in] long IDMode)
This method causes the control to display a particular Changemark. The Changemark displayed is determined by CMID and IDMode. Valid values for IDMode and their effect on the interpretation of CMID are:
BRAVAX_CMID_MODE_TITLE = 0
The control will attempt to execute the first Changemark within the list whose title is equal to CMID.
BRAVAX_CMID_MODE_INDEX = 1
The control will attempt to execute the Changemark within the list whose index is equal to CMID.
CMID_MODE_GUID = 2
The control will attempt to execute the Changemark within the list whose markup entity GUID is equal to CMID.
See GetChangemarkInfo for additional information.
([in]long Index,
[out] BSTR *Guid,
[out] BSTR *Title,
[out] BSTR *Comment,
[out] BSTR *Author,
[out] BSTR *Link,
[out] BSTR *Metadata,
[out] long *Time,
[out] long *PageNum,
[out] BOOL *IsEditable)
This method retrieves information about a particular Changemark. Use property NumberChangemarks to determine the total number of Changmarks that currently exist.
Index = The Changemark within the list whose information is to be retrieved.
Guid = The Changemark's markup entity unique string identifier.
Title = The Changemarks's title.
Comment = The Changemarks's comment.
Author = The Changemarks's author name.
Link = The Changemarks's hyperlink if any exists.
Metadata = Not currently used.
Time = The time stamp indicating when the Changemark was created, measured in UTC time.
PageNum = The page number on which the Changemark exists.
IsEditable = 0 if the Changemark is editable. I if the Changemark is not editable.
This method causes the control to create a new un-named editable markup stamp template.
This method causes any editable markup stamp template file currently open to be closed.
This method causes the control to save all changes to the currently open editable markup stamp template.
If the currently open markup stamp template has not been previously saved, the control will prompt for a file name using one of the methods described in the File IO Option Section.
(BSTR fileName)
This method causes the control to save the current state of the currently open editable markup stamp template file. The markup stamp template will be saved to the file indicated by the file name.
(BSTR fileName)
This method causes the control to open an existing editable markup stamp template file. If there is currently an editable markup stamp template open, this editable markup stamp template file will be closed.
([in] BSTR ID,
[in] long Action,
[in] BSTR ActionInfo)
This method causes the control to modify or affect a particular markup entity or group of markup entities. The markup entities affected are determined by the ID parameter.
The ID parameter must be a string list of markup entity GUIDs delimited by '<|>'.
See Event MarkupEntityModified for more information about markup GUIDs.
Valid values for Action and their effect on the markup entity are:
BRAVAX_MODMRK_SELECT = 0
The control will attempt to select the markup entities identified by the ID parameter.
BRAVAX_MODMRK_DESELECT = 1
The control will attempt to deselect the markup entities identified by the ID parameter.
ActionInfo is not currently used
Boolean. Based on the value of DisplayToolbarTools, the top toolbar containing PAN, ZOOM WINDOW, ZOOM IN/OUT, and MAGNIFIER buttons will be displayed or removed.
Example:
viewObject.DisplayToolbarTools = FALSE // remove the mouse tools toolbar.
Boolean. Based on the value of DisplayToolbarView, the top toolbar containing MARKUP, PRINT, MEASURE, SELECT, FITALL, and FITWIDTH buttons will be displayed or removed.
Example:
viewObject.DisplayToolbarView = FALSE //remove the view tools toolbar.
Boolean. Based on the value of DisplayToolbarPage, the bottom toolbar containing ROTATE90, SHOW LAYERS, TOGGLE COLOR/MONOCHROME, CHANGE BACKGROUND COLOR, PAGE NEXT AND PREVIOUS, and PAGE COMBO buttons will be displayed or removed.
Example:
viewObject.DisplayToolbarPage = FALSE //remove the page tools toolbar.
Boolean. Based on the value of DisplayFIndCtrl, the bottom toolbar containing FIND and FIND TEXT COMBO buttons will be displayed or removed.
Example:
viewObject.DisplayFindCtrl = FALSE //remove the find tools toolbar.
String. This property is for use with the standardized integration dll. The integration dll will be asked for a string representing its description.
String. This property is for use with the standardized integration dll. The integration dll will be asked for a string representing its version.
Boolean. Setting this property to TRUE causes the control to not display error messages. By default, SuppressInfoMessages is set to FALSE.
Boolean. If set to 0, the control will not display a menu when the right mouse button is clicked (while the cursor is within the drawing/document view area). The default is 1.
Boolean. The following properties can be used to disable/enable particular control functions. If a given property is set to FALSE, the control will not allow the corresponding functionality. By default, all of these properties are set to TRUE.
AllowFileOpen
AllowPrinting
AllowMarkup
AllowMeasurement
AllowLayers
AllowFind
AllowCopyText
AllowMrkReview
AllowMrkSaveAsDXF
AllowMrkSaveAs
AllowMrkSave
AllowMrkOpen
AllowMrkNew
AllowPageControl
AllowRotate
AllowBKColor
AllowMonochrome
CtrlDisplayed(int ctrlID,BOOL *pVal)
This method returns a boolean value to indicate if a control (button or other UI element) identified by int crtlID has been removed. If the control is removed, BOOL pVal will be FALSE. See Control Identification Section for a list of acceptable control IDs.
CtrlEnabled(int ctrlID,BOOL *pVal)
This method returns a boolean value to indicate if a control (button or other UI element) identified by int crtlID has been disabled. If the control is disabled, BOOL pVal will be FALSE. See Control Identification Section for a list of acceptable control IDs.
DisplayCtrl(int ctrlID,BOOL newVal)
This method allows a control (button or other UI element) to be displayed or removed based on the value of BOOL newVal. See Control Identification Section for a list of acceptable control IDs.
EnableCtrl(int ctrlID,BOOL newVal)
This method allows a control (button or other UI element) to be enabled or disabled based on the value of BOOL newVal. See Control Identification Section for a list of acceptable control IDs.
([in] int keyID, [in] BOOL shift, [in] BOOL newval)
This method allows a container to disable hot key (Ctrl + char) combinations. The key combination is specified by keyID, and shift indicates whether the shift key is pressed. If newval is set to false, the key command will be disabled. See Control Key Combinations for a list of valid values for keyID.
([in] int keyID, [in] BOOL shift, [out, retval] BOOL*pval)
This method gets the enabled state of a given key combination.
([in] BSTR Param1, [in] BSTR Param2, [out, retval] BSTR *pResponse)
This method is for use with the standardized integration dll and can be used to pass custom information to the integration dll. Any response given by the integration dll will be returned in the pResponse string.
Content Secure Format files (csf) can be published with individual Visual Rights enabled or disabled. The following list of properties are each Boolean values indicating the state of a particular Visual Right. These properties are valid only if the document or drawing currently being viewed is a Content Secure Format file (csf).
VRPrintingEnabled
VRCopyTextEnabled
VRMeasurementEnabled
VRLayersEnabled
VRSaveAsJPGEnabled
VRMarkupReviewEnabled
VRMarkupEditEnabled
VRMarkupBurnInEnabled
VRRepublishingEnabled
VRDateExpiredEnabled
VRPasswordProtectEnabled
ShowVisualRightsSettings()
This method causes the control to display a modal dialog that informs the user of the Visual Rights settings of the currently viewed Content Secure Format file. This method is available only if the document or drawing currently viewed is a Content Secure Format file (csf).
Boolean. This property is used to get/set a Boolean value indicating how to display the control Windows help file. If this value is TRUE, the control will fire the DisplayHelp(contextID) and the container is responsible for handling the users request for help. If set to FALSE, the control will attempt to launch the Windows help file itself. This property is set to FALSE by default.
Boolean. If set to true, the control launches the URL specified by the HelpURL property when any of the controls help buttons are pressed. Defaults to false.
See Also:
HelpUrl
Event DisplayHelp
RequestHelpDisplay
DisplayHelpTopic
String. If property LaunchUrlHelp is set to true, the machines default browser is invoked with this string whenever any help button in the control is pressed. Also, a parameter is appended to the HelpUrl string to indicate the help topic requested. The string passed to the browser is in the form:
HelpUrl?HContext=TopicID
See section HelpTopicIDs for a listing of possible TopicIDs.
DisplayHelpTopic(short TopicID)
This method causes the control to either launch the Windows help file with the given TopicID, or fire the DisplayHelp(ContextID) event with the given TopicID, based on the value of RequestHelpDisplay. See Help Topic IDs Section for a list of acceptable Topic IDs.
String. Read Only. This property is used to get the current error message string.
String. Read Only. This property is used to get the version of control. The version string is formatted:
Major,Minor1,Minor2,BuildNo.
String. Read Only. This property is used to get the license string of control if applicable.
Boolean. If RequestFileIOEvents property is TRUE, setting UseStandardCSFOutput to FALSE will cause the control to fire the RequestExportCSFFilename event. This allows a container to provide file IO when creating CSF files. If UseStandardCSFOutput is set to TRUE (default), the control will provide the file IO when creating CSF files.
SaveViewAs(string filename, short type)
This method causes the control to save the current view as an alternate format (e.g. JPG). The resulting alternate format will be saved to a file named filename. Currently only JPG is supported, but in the future other formats may be added (e.g. PDF). The parameter type is specified as follows:
JPG - 0
BurnInMarkup()
This method causes the control to create a new CSF file with the currently open markups burned-in. The control will prompt the user for a filename. If the currently viewed document is CSF, the newly created CSF will inherit all applicable Visual Rights security settings. If the currently viewed document or drawing is a native format, the user will be prompted to specify the desired Visual Rights setting to apply to the new CSF.
PublishToCSF(bool BurnInMarkups)
This method causes the control to create a new CSF file containing the content of currently viewed document or drawing. The user will be prompted for a filename. This method is only available if the currently viewed document or drawing is not already a CSF file. Because of Visual Rights settings, a CSF file can not be republished. If the parameter BurnInMarkups is TRUE, any currently open markups will be burned in to the resulting CSF file.
([in] BSTR Filename,[in] BOOL BurnInMarkups)
This method creates a CSF rendition of the currently viewed document or drawing. If BurnInMarkups is set to TRUE, any open markups are burned into the resulting CSF file.
([in] BSTR Filename,[in] BOOL BurnInMarkups)
This method creates a CSF rendition of the currently viewed document or drawing. If BurnInMarkups is set to TRUE, any open markups are burned into the resulting CSF file. No dialogs for determining export options will be presented. If the currently viewed file is a CSF file, the Visual Rights effective in the new CSF file will be identical to the original. If the currently viewed file is of any other format, the resulting CSF file will have the most permissive Visual Rights possible.
([in] BSTR Filename,[in] BOOL ForceMonochrome)
This method creates a TIFF rendition of the currently viewed document or drawing.
This method has been superseded by ExportTiffEx.
Filename = output filename
ForceMonochrome = if set to True, the resulting TIFF file will be black and white only.
([in] BSTR Filename,
[in] BSTR MetaDataString,
[in] BOOL ForceMonochrome,
[in] BOOL OutputChangemarks,
[in] BOOL OutputRedactionInfo,
[in] int Dpi,
[in] int ViewStateExports,
[in] BOOL UseCustomPageSize,
[in] double CustomPageWidth,
[in] double CustomPageHeight)
This method creates a TIFF rendition of the currently viewed document or drawing.
Filename = output filename
MetaDataString = not currently used.
ForceMonochrome = if set to TRUE, the resulting TIFF file will be black and white only.
OutputChangemarks= not currently used.
OutputRedactionInfo= not currently used.
Dpi = controls pixel density of output TIFF.
ViewStateExports= a set of bit flags that indicate what view state elements of the currently open drawing or document will be reflected in the output file.
Current possible values:
EXPORT_VIEWSTATE_NONE = 0x000
The file will be exported in its default state. No changes to the appearance of the current drawing or document during the viewing session.
EXPORT_VIEWSTATE_ROTATIONS = 0x0001
All page rotations made during the viewing of the current drawing or document will be reflected in the output file.
UseCustomPageSize = controls whether the output TIFF uses the current document/drawing dimensions, or CustomPageWidth and CustomPageHeight.
CustomPageWidth= if UseCustomPageSize is TRUE, the width in inches of the output TIFF.
CustomPageHeight= if UseCustomPageSize is TRUE, the height in inches of the output TIFF.
([in] BSTR Filename,
[in] BSTR MetaDataString,
[in] BSTR Password,
[in] BOOL PasswordProtected,
[in] BOOL OutputChangemarks,
[in] BOOL OutputRedactionInfo,
[in] BOOL FlattenLayers,
[in] int ViewStateExports,
[in] BOOL UseCustomPageSize,
[in] double CustomPageWidth,
[in] double CustomPageHeight,
[in] BSTR Description);
This method creates a DWF rendition of the currently viewed document or drawing.
Filename = output filename
MetaDataString= not currently used.
Password= DWF password for viewing.
PasswordProtected= if set to TRUE, creates DWF file using password.
OutputChangemarks= not currently used.
OutputRedactionInfo= not currently used.
FlattenLayers= if set to TRUE, all entities on all layers in the current drawing or document will be placed in a single default layer on the output DWF.
ViewStateExports= a set of bit flags that indicate what view state elements of the currently open drawing or document will be reflected in the output file.
Current possible values:
EXPORT_VIEWSTATE_NONE = 0x000
The file will be exported in its default state. No changes to the appearance of the current drawing or document during the viewing session.
EXPORT_VIEWSTATE_ROTATIONS = 0x0001
All page rotations made during the viewing of the current drawing or document will be reflected in the output file.
UseCustomPageSize = controls whether the output DWF uses the current document/drawing dimensions, or CustomPageWidth and CustomPageHeight.
CustomPageWidth= if UseCustomPageSize is TRUE, the width in inches of the output DWF.
CustomPageHeight= if UseCustomPageSize is TRUE, the height in inches of the output DWF.
Description = not currently used.
([in] BSTR Filename,[in] BOOL MrkAsPDFAnnotations)
This method creates a PDF rendition of the currently viewed document or drawing. If MrkAsPDFAnnotations is set to TRUE, any open markups are converted to PDF annotations in the resulting PDF file.
([in] BSTR Filename,
[in] BSTR MetaDataString,
[in] BSTR OwnerPassword,
[in] BSTR UserPassword,
[in] BOOL PasswordProtected,
[in] BOOL MrkAsPDFAnnotations,
[in] BOOL OutputChangemarks,
[in] BOOL OutputRedactionInfo,
[in] BOOL DoBlockAttributes,
[in] BOOL DoHyperlinks,
[in] BOOL DoBookmarks,
[in] BOOL DoLayers,
[in] BOOL PDFRights,
[in] int ViewStateExports,
[in] BOOL UseCustomPageSize,
[in] double CustomPageWidth,
[in] double CustomPageHeight)
This method creates a PDF rendition of the currently viewed document or drawing.
Filename = output filename.
MetaDataString = not currently used.
OwnerPassword = PDF password for editing.
UserPassword = PDF password for viewing.
PasswordProtected = if set to TRUE creates PDF file using OwnerPassword and UserPassword.
MrkAsPDFAnnotations = if set to TRUE all markup currently open will be inserted in to the output PDF as PDF annotations. If set to FALSE all currently open markup will be 'burned-in' as normal PDF entities.
OutputChangemarks = If set to '1' any Changemarks existing in the currently open drawing/document will be numbered and listed at the end of the PDF output. If not set to '1' Changemarks will not be numbered and listed at the end of the PDF output.
OutputRedactionInfo = not currently used.
DoBlockAttributes = if set to TRUE any blocks with attributes in the current drawing or document will be inserted into the output PDF as hot spot block attributes.
DoHyperlinks = if set to TRUE any hyperlink entities in the current drawing or document will be inserted into the output as PDF hyperlinks.
DoBookmarks = if set to TRUE any bookmark entities in the current drawing or document will be inserted into the output as PDF bookmarks.
DoLayers = if set to TRUE all layers in the current drawing or document will have a corresponding layer in the output PDF.
PDFRights = not currently used
ViewStateExports= a set of bit flags that indicate what view state elements of the currently open drawing or document will be reflected in the output file.
Current possible values:
EXPORT_VIEWSTATE_NONE = 0x000
The file will be exported in its default state. No changes to the appearance of the current drawing or document during the viewing session.
EXPORT_VIEWSTATE_ROTATIONS = 0x0001
All page rotations made during the viewing of the current drawing or document will be reflected in the output file.
UseCustomPageSize = controls whether the output PDF uses the current document/drawing dimensions, or CustomPageWidth and CustomPageHeight.
CustomPageWidth = if UseCustomPageSize is TRUE, the width in inches of the output PDF.
CustomPageHeight = if UseCustomPageSize is TRUE, the height in inches of the output PDF.
([in]BSTR Filename, [in]short Type, [in]short Quality)
This method works the same as SaveViewAs except it allows the addition of a Quality parameter
Filename = output filename.
Type = output type (see SaveViewAs)
Quality = integer value to control output quality. Must be a value between 1 and 100.
1 is the lowest quality and smallest output, 100 is the highest quality and largest output.
String. Used to get/set the name of the document or drawing to be compared against the currently open file.
Integer. Used to get/set the current compare mode. The following are valid values:
CVM_OVERLAY = 1
CVM_OVERLAY_DIFF = 2
CVM_SIDE_BY_SIDE = 3
CVM_SIDE_BY_SIDE_DIFF = 4
CVM_OLDER_DOC = 5
CVM_NEWER_DOC = 6
CVM_ADDITIONS = 7
CVM_DELETIONS = 8
CVM_UNCHANGED = 9
Integer. Used to get/set the percent value of the amount that different entities in the compare drawing are shown while in CVM_OVERLAY_DIFF mode or CVM_SIDE_BY_SIDE_DIFF mode. If CompareViweMixtureLevel is 50, the open file and compare file display equally. A value of 100 displays only the compare file while a value of 0 displays only the open file.
Boolean. (Read-only) This property is set to true if the compare alignment tool has been used.
Boolean. (Read-only) This property is set to true if a compare document has been attached.
Integer. (Read-only) This property is used to get the number of pages in the compare document.
Integer. (Read-only) This property is set to get the page number currently displayed by the compare document.
This method closes any drawings or documents that have been opened as compare files.
If the compare alignment tool has been used to align a base and compare document, this method causes the alignment of the two documents to return to their original default values.
Boolean. Used to get/set the control property that governs the firing of collaboration events. If set to true, the control will fire the following events:
CDLEvent with an eventide of NE_VIEW_CHANGED
MarkupEntityModified
Example:
Viewobject.CollaborationMode = TRUE. //Tell the control to inform the container on all viewstate changes
(double *EyeX, double *EyeY, double *Width, double *Height, double *Rotation, int CoordSys)
This method retrieves the current viewport values relative to the extents of the document/drawing. EyeX and EyeY are the x and y values of the center of the view. Width and Height indicate scale or zoom level. Rotation is measured in degrees. CoordSys governs the coordinate system used as follows:
BRAVAX_WORLD = 0
If CoordSys is set to 0, the real values returned by GetCurrentViewportState will be in the drawing/documents native units.
BRAVAX_ABSOLUTE_SCALE = 1
If CoordSys is set to 1, the EyeX and EyeY returned by GetCurrentViewportState will be in the drawing/documents native units. Width will be the scale value required to convert EyeX and EyeY into device space. Height is ignored.
BRAVAX_NDC = 2
If CoordSys is set to 2, the real values returned by GetCurrentViewportState will be in normalized device coordinates.
(double EyeX, double EyeY, double Width, double Height, double Rotation, int CoordSys)
This method changes the current viewport state relative to the extents of the document/drawing. EyeX and EyeY are the x and y values of the center of the view. Width and Height indicate scale or zoom level. Rotation is measured in degrees. CoordSys governs the coordinate system used as follows:
BRAVAX_WORLD = 0
If CoordSys is set to 0, the real values used by SetCurrentViewportState will be in the drawing/documents native units.
BRAVAX_ABSOLUTE_SCALE = 1
If CoordSys is set to 1, the EyeX and EyeY used by SetCurrentViewportState will be in the drawing/documents native units. Width will be the scale value required to convert EyeX and EyeY into device space. Height is ignored.
BRAVAX_NDC = 2
If CoordSys is set to 2, the real values used by SetCurrentViewportState will be in normalized device coordinates.
.
([in] BSTR EntityID, [out,retval] BSTR *EntityData)
This method retrieves a string representation of a markup entity uniquely identified by EntityID. The string representation can then be used to modify a markup entity through SetMarkupEntity. See Event MarkupEntityModified for more information.
([in] BSTR EntityID, [in] BSTR *EntityData)
This method modifies a markup entity uniquely identified by EntityID with the data in EntityData string. See Event MarkupEntityModified for more information.
([out,retval] BSTR *LayerData)
This method returns the current drawing layer visibility state map in string form.
([in] BSTR *LayerData)
This method modifies the current drawing layer visibility state map.
([out,retval] int *NumLayers)
This method returns the number of layers in the current drawing layer visibility state map.
([in] int Index,[out] BSTR *LayerName,[out] BOOL *DefaultVisibility,[out,retval] BOOL *CurrentVisibility)
This method retrieves information for an individual layer identified by Index.
([in] int Index, [in] BOOL *CurrentVisibility)
This method modifies the visibility for an individual layer identified by Index.
([out] double *Width, [out] double *Height)
This method gets Width and Height of the currently viewed document or drawing in the files native units.
([in]XRefPathTypes PathType, [out,retval] BSTR *XRefPath)
This method returns a listing of the paths the control searches in order to find drawing external references each individual path is serrated by a semicolon. XRefPathTypes can be set to one of the following:
BRAVAX_DWG_XREF_PATH
Paths searched to find external reference files for AutoCad.
BRAVAX_DWG_SHXFONT_PATH
Paths searched to find AutoCad font and shape files.
BRAVAX_DGN_XREF_PATH
Future use only.
([in] XRefPathTypes PathType, [in] BSTR XRefPath)
This method modifies the paths the control searches to find various drawing external reference files. See GetXRefPath for XRefPathTypes possible values
([in] XRefPathTypes PathType, [out,retval] int *Level)
This method returns an integer to indicate the controls behavior if it is unable to find a drawings externally referenced file. See GetXRefPath for XRefPathTypes description. Possible Levels are:
BRAVAX_XREF_WARN = 0
Display a warning message on failure to find an external reference.
BRAVAX_XREF_IGNORE = 1
Do not display a warning message on failure to find an external reference.
BRAVAX_XREF_ABORT = 2
Display a warning message on failure to find an external reference and abort the file load.
([in] XRefPathTypes PathType, [in] int Level)
This method modifies the controls behavior if it is unable to find a drawings externally referenced file. See GetXrefWarningLevel and GetXRefPath.
([out, retval] long *NumPrinters)
long *NumbPrinters = Total number of printers found and enumerated on the system.
BXEnumeratPrinters creates a list of printers accessible on the current Windows system. BXEnumeratePrinters must be called prior to using any other API methods.
([out retval] BSTR *IDs)
BSTR *IDs = List of unique string IDs.
BXGetPrinterIDs retrieves a list of unique string IDs for all of the printers enumerated by a call to BXEnumeratePrinters. A unique string ID is used to get/set information and settings pertaining to a particular printer in subsequent API methods. The list is delimited using the characters '<|>':
[printer id 1]<|>[printer id 2]<|>[printer id 3]
([out retval] BSTR *Names)
BSTR *Names = List of string printer names.
BXGetPrinterNames retrieves a list of printer names for all of the printers enumerated by a call to BXEnumeratePrinters. Note that this list should contain exactly one name for each printer ID retrieved using method BXGetPrinterIDs. The list is delimited using the characters '<|>':
[printer name 1]<|>[printer name 2]<|>[printer name 3]
([in] BSTR PrinterID, [out,retval] BSTR *Name)
BSTR PrinterID = Used to identify the printer.
BSTR *Name = Name of the printer identified by PrinterID.
BXGetPrinterName retrieves the printer name of the printer identified by PrinterID.
([out, retval] BSTR *Name)
BSTR *Name = Name of the printer currently set as the Windows default printer.
BXGetDefaultPrinterName retrieves the printer name of the printer currently set as the Windows default printer.
([in] BSTR PrinterID,[out,retval] BSTR *SizesEnum)
BSTR PrinterID = Used to identify the printer.
BSTR *SizesEnum = List of enum values for each paper size available on the printer identified by PrinterID.
BXGetPaperSizesEnum retrieves a list of values for each paper size available on the printer identified by PrinterID. Each element in this list is a string that corresponds to an integer value that uniquely identifies an available paper size. See method:BXSetPaperSize for additional details. The list is delimited using the characters '<|>':
[paper size 1]<|>[paper size 2]<|>[paper size 3]
([in] BSTR PrinterID,[out,retval] BSTR *SizesName)
BSTR PrinterID = Used to identify the printer.
BSTR *SizeName = List of name values for each paper size available on the printer identified by PrinterID.
BXGetPaperSizeName retrieves a list of names (e.g. Letter, 8.5x11) for each paper size available on the printer identified by PrinterID. Note that this list should contain exactly one paper size name for each paper size enum retrieved using BXGetPaperSizesEnum. The list is delimited using the characters '<|>':
[paper size 1]<|>[paper size 2]<|>[paper size 3]
([in] BSTR PrinterID,[out,retval] BSTR *SizesValue)
BSTR PrinterID = Used to identify the printer.
BSTR *SizesValue = List of string values for each paper size available on the printer identified by PrinterID.
BXGetPaperSizesValue retrieves a list of strings that indicate the physical size of each paper size available on the printer identified by PrinterID. Each element in this list will be a string in the form: [WidthxHeight] where Width and Height are integer values measured in 0.1 mm. Note that this list should contain exactly one paper size value for each paper size enum retrieved using method BXGetPaperSizesEnum. The list is delimited using the characters '<|>':
[paper size value 1]<|>[paper size value 2]<|>[paper size value 3]
([in] BSTR PrinterID,[in] long PaperSource)
BSTR PrinterID = Used to identify the printer.
long PaperSource = Enum value to indicate which paper source to use.
BXSetPaperSource tells the printer identified by PrinterID to output using the paper from the source indicated by PaperSource. PaperSource must be one of the values retrieved by a call to BXGetPaperSourcesEnum.
([in] BSTR PrinterID,[out,retval] long *PaperSource)
BSTR PrinterID = Used to identify the printer.
long PaperSource = Enum value to indicate which paper source is currently in use.
BXGetPaperSource gets the current paper source of the printer identified by PrinterID. PaperSource will be one of the values retrieved by a call to BXGetPaperSourcesEnum.
BXGetPaperSourcesEnum
([in] BSTR PrinterID,[out,retval] BSTR *SourcesEnum)
BSTR PrinterID = Used to identify the printer.
BSTR *SourcesEnum = List of enum values for each paper sources available on the printer identified by PrinterID.
BXGetPaperSourcesEnum retrieves a list of values for each paper source available on the printer identified by PrinterID. Each element in this list is a string that corresponds to an integer value that uniquely identifies an available paper source. See method:BXSetPaperSource for additional details. The list is delimited using the characters '<|>':
[paper source 1]<|>[paper source 2]<|>[paper source 3]
([in] BSTR PrinterID,[out,retval]BSTR *SourcesName)
BSTR PrinterID = Used to identify the printer.
BSTR *SourcesName = List of name values for each paper sources available on the printer identified by PrinterID.
BXGetPaperSourcesName retrieves a list of names (e.g. Upper Paper Tray) for each paper source available on the printer identified by PrinterID. Note that this list should contain exactly one paper source name for each paper source enum retrieved using method BXGetPaperSourcesEnum. The list is delimited using the characters '<|>':
[paper source name 1]<|>[paper source name 2]
([in] BSTR PrinterID,[out,retval] BSTR *ResolutionsValue)
BSTR PrinterID = Used to identify the printer.
BSTR *ResolutionsValue = List of values for each resolution available on the printer identified by PrinterID.
BXGetPaperSourcesEnum retrieves a list of strings that indicate the resolutions available on the printer identified by PrinterID. Each element in this list will be a string in the form: [ResXxResY] where ResX and ResY are integer values measured in dots per inch. See method:BXSetResolution for additional details. The list is delimited using the characters '<|>':
[resolution 1]<|>[ resolution 2]<|>[ resolution 3]
([in] BSTR PrinterID,[out,retval] long *DriverVersion)
BSTR PrinterID = Used to identify the printer.
long *DriverVersion = Integer version value.
BXGetDriverVersion retrieves the version number of the printer driver for the printer identified by PrinterID.
([in] BSTR PrinterID,[out,retval] BOOL*SupportsDuplex)
BSTR PrinterID = Used to identify the printer.
BOOL *SupportsDuplex = Boolean duplex value.
BXGetSupportsDuplex returns true if the printer identified by PrinterID supports Duplex printing mode.
([in] BSTR PrinterID,[out,retval] BOOL *SupportsCollate)
BSTR PrinterID = Used to identify the printer.
BOOL *SupportsCollate = Boolean collate value.
BXGetSupportsCollate returns true if the printer identified by PrinterID supports collation.
([in] BSTR PrinterID,[out,retval] BOOL *IsColorPrinter)
BSTR PrinterID = Used to identify the printer.
BOOL *IsColorPrinter = Boolean color ability value.
BXGetIsColorPrinter returns true if the printer identified by PrinterID is able to print color output.
([in] BSTR PrinterID,[in] long PaperSize)
BSTR PrinterID = Used to identify the printer.
long PaperSize = Enum value to indicate which paper size to use.
BXSetPaperSize tells the printer identified by PrinterID to output using the paper size indicated by PaperSize. PaperSize must be one of the values retrieved by a call to BXGetPaperSizesEnum.
([in] BSTR PrinterID,[out,retval] long *PaperSize)
BSTR PrinterID = Used to identify the printer.
long PaperSize = Enum value to indicate which paper size is currently in use.
BXGetPaperSize gets the current paper size of the printer identified by PrinterID. PaperSize will be one of the values retrieved by a call to BXGetPaperSizseEnum.
([in] BSTR PrinterID,[in] long Orientation)
BSTR PrinterID = Used to identify the printer.
long Orientation = Integer value used to indicate landscape or portrait print output.
BXSetOrientation allows the printer identified by PrinterID to be put in landscape or portrait mode using one of the following values:
ORIENT_PORTRAIT = 1
ORIENT_LANDSCAPE = 2
([in] BSTR PrinterID,[out,retval] long *Orientation)
BSTR PrinterID = Used to identify the printer.
long *Orientation = Integer value used to indicate landscape or portrait print output.
BXGetOrientation gets the current orientation of the printer identified by PrinterID. Valid values are:
ORIENT_PORTRAIT = 1
ORIENT_LANDSCAPE = 2
([in] BSTR PrinterID)
BSTR PrinterID = Used to identify the printer.
A call to BXSetPrionter will cause the Brava control to use the printer identified by PrinterID for all subsequent printing operations. Note that the printer used can be resent by an end-user interacting with the standard Brava Print dialog.
([in] long PrintScaleType)
long PrintScaleType = Integer value indicating the scaling type used.
BXSetPrintScaleType allows the currently open document to be print scaled in one of the following ways:
PRT_SCALE_FIT = 0
Make the document fit the extents of the paper.
PRT_SCALE_INSIDE_BANNERS = 1
Make the document fit the extents of the paper, but scale down so that any banners will be printed outside the extents of the document.
PRT_SCALE_DOCUMENT = 2
Use the documents native scale.
([out,retval] long *PrintScaleType)
long *PrintScaleType = Integer value indicating the scaling type used.
BXGetPrintScaleType returns the print scale type used by the currently open document.
([in] double PrintScaleFactor)
double PrintScaleFactor = Real value indicating the scaling factor.
BXSetPrintScaleFactor allows a custom scale factor to be applied to each page printed in the currently open document. Note that the PrintScaleFactor is only applicable if the PrintScaleType is set to PRT_SCALE_DOCUMENT.
([out,retval] double *PrintScaleFactor)
double *PrintScaleFactor = Real value indicating the scaling factor.
BXSetPrintScaleFactor returns the custom scale factor to be applied to each page printed in the currently open document. Note that the PrintScaleFactor is only applicable if the PrintScaleType is set to PRT_SCALE_DOCUMENT
([in] long PageNum,[out, retval] long *NumBlocks)
GetNumberOfBlocks returns the total number of blocks found on the page specified by PageNum.
([in] long PageNum,[in] long BlockIndex,[out, retval] BSTR *Attributes)
GetBlockAttributes returns the attributes associated with the block found at BlockIndex within the list of blocks found on the page specified by PageNum.
The Attributes will be in the form of each individual attribute delimited by the following character sequence <|>
Each individual attribute will contain a tag-value combination in the following format:
[tag string]: [value string]
Example return value of GetBlockAttributes for a block containing three attributes:
[tagA]: [valueA]<|>[tagB]: [valueB]<|>[tagC]: [valueC]'
([in] long PageNum,[in] long BlockIndex,[in] BSTR Color, [out, retval] BOOL *Success)
SetBlockColor will set the rendering color of the block found at BlockIndex within the list of blocks found on the page specified by PageNum.
If the block can be found and its color set, the return value Success will be set to TRUE.
If the block can not be found or its color can not be set, the return value Success will be set to FALSE.
The parameter Color is interpreted as either a string representation of an RGB value or one of the following strings:
white = RGB(255,255,255)
yellow = RGB(255,255,0)
magenta = RGB(255,0,255)
red = RGB(255,0,0)
cyan = RGB(0,255,255)
green = RGB(0,255,0)
blue = RGB(0,0,255)
darkGrey = RGB(128,128,128)
grey = RGB(192,192,192)
olive = RGB(128,128,0)
purple = RGB(128,0,128)
maroon = RGB(128,0,0)
teal = RGB(0,128,128)
pine = RGB(0,128,0)
darkBlue = RGB(0,0,128)
black = RGB(0,0,0)
([in] long PageNum,[in] long BlockIndex,[out, retval] BOOL *Success)
ZoomToBlock will cause the Brava viewer to zoom to the block found at BlockIndex within the list of blocks found on the page specified by PageNum.
If the block can be found and the view state change is successful, the return value Success will be set to TRUE.
If the block can not be found or the view state change is unsuccessful, the return value Success will be set to FALSE.
([in] long PageNum,[in] long BlockIndex,[out, retval] BOOL *Success)
DisplayBlockAttributes method will cause the control to display a dialog box containing the information about the block indicated by BlockIndex and found on the page specified by PageNum. Success will be set to 1 if the block is successfully displayed, 0 if not.
RequestOpenFileGUI()
Fired when the user has attempted to open a document or drawing and Property:RequestFileIOEvents property is TRUE. The container is then responsible for prompting the user for a document or drawing file name to open and then setting Properties:Filename to open the desired document or drawing file.
FileLoaded(BSTR Filename)
Fired when a document or drawing is successfully loaded.
FileClosed()
Fired when a document or drawing is closed.
FileLoadFailure(BSTR Filename)
Fired when an attempt to open a document or drawing has failed. Property:ErrorMessage can be used for more information.
([in]long PasswordType,
[in]BSTR Filename,
[in,out]long* PromptForPassword)
This event is fired when the control attempts to open a password protected file. FileIsPasswordProtected is fired before the control displays a dialog requesting the user to enter a password. Currently the control supports password protected PDF files and password protected CSF files. CSF files can be password protected both for general opening/viewing and may also have password protection that allows any redaction entities to appear opaque. The PasswordType parameter indicates the type of password that will be requested. Valid values for PasswordType are:
BRAVAX_PASSWORD_CSF = 0
BRAVAX_PASSWORD_REDACTION = 1
BRAVAX_PASSWORD_NATIVEFILE = 2 (PDF)
The Filename parameter is the full path and filename of the document/drawing that is password protected. A listener to this event can suppress the password dialog by setting the PromptForPassword parameter to zero. Note that if PromptForPassword is set to zero, and PasswordType = BRAVAX_PASSWORD_CSF or BRAVAX_PASSWORD_NATIVEFILE, the document will not be opened.
RequestMarkupFileReview()
Fired when a user has attempted to open a review markup file, and Property:RequestFileIOEvents is TRUE. The container is then responsible for prompting the user for a review markup file name to open and then calling method:OpenMarkupReview(BSTR fileName) to open the desired review markup file.
MarkupReviewLoaded(BSTR Filename)
Fired when a review markup file has been successfully loaded.
MarkupReviewClosed(BSTR Filename)
Fired when a review markup file has been closed.
RequestMarkupFileEdit()
Fired when the user has attempted to open an editable markup file, and Property:RequestFileIOEvents property is TRUE. The container is then responsible for prompting the user tor an editable markup file name to open and then calling method:OpenMarkupEdit(BSTR fileName) to open the desired editable markup file.
MarkupEditCreated()
Fired when the control has created a new editable markup.
MarkupEditLoaded(BSTR Filename)
Fired when an editable markup file has been successfully loaded.
MarkupEditClosed(BSTR Filename)
Fired when an editable markup file has been closed.
RequestMarkupSaveAs()
Fired when the user has attempted to save an editable markup file, and RequestFileIOEvents property is TRUE. The container is then responsible for prompting the user for an editable markup file name to save and then calling the method:SaveAsMarkupEdit(BSTR fileName) to save the desired editable markup file.
RequestMarkupSaveAsDXF()
Fired when the user has attempted to save a markup file, and a DXF and RequestFileIOEvents property is TRUE. The container is then responsible for prompting the user for a DXF file name to save and then calling the method: SaveAsMarkupEditDXF (BSTR fileName) to save the desired editable markup file as DXF.
MarkupLoadFailure(BSTR Filename)
Fired when an attempt to open a markup has failed. Property:ErrorMessage can be used for more information.
BurnInFailure(BSTR Filename,PublishOutputOptions option)
Fired when an attempt to burn in the currently open a markup has failed. Property:ErrorMessage can be used for more information.
PublishOutputOptions indicate the type of publishing output requested by the user. The following are valid values:
BRAVAX_PO_FILE_ONLY = 0
BRAVAX_PO_EMAIL = 1
BRAVAX_PO_WEB_PAGE = 2
The parameter Filename returned by any of the publishing events is based on the PublishOutputOptions value and is as follows:
BRAVAX_PO_FILE_ONLY = Full path of published file.
BRAVAX_PO_EMAIL = Title of email message (generally
the published file name).
BRAVAX_PO_WEB_PAGE = Full path of the directory containing the published file, the html created, and any support files referenced by the html.
BurnInSuccess(BSTR Filename,PublishOutputOptions option)
Fired when an attempt to burn in the currently open a markup has succeeded.
Property: ErrorMessage can be used for more information.
See PublishOutputOptions in BurnInFailure section for additional details.
([in] BSTR ID,
[in] BSTR Metadata,
[in,out] long* DisplayDlg,
[in,out] BSTR* Reason)
This event is fired prior to editing the redaction reason of any redaction entity or group of redaction entities.
The redaction entities that are having their reasons edited are identified by ID. The ID parameter will be a string list of redaction entity GUIDs delimited by '<|>'. See Event MarkupEntityModified for more information about markup GUIDs.
The Reason parameter will be a string of the current reasons for each entity delimited by '<|>'. Note that each entry in the ID list must have a corresponding entry in the Reasons list and the order of both lists is synchronized. A listener to this event may suppress the dialog that the control displays to allow a user to enter redaction reasons by setting the value of DisplayDlg to zero. If DisplayDlg is set to zero, a listener may also edit the reasons by changing the string values found in the Reason parameter.
The Metadata parameter is currently not used.
([in]long PropertyType,
[in] BSTR ID,
[in]BSTR Metadata,
[in,out]long* CtrlHandle,
[in,out]BSTR* Property)
This event is fired prior to the editing of certain properties on a markup entity (or group of markup entities). The type of property being edited is indicated by the PropertyType parameter.
See below for a list of the current properties for which this event is fired.
The markup entities that are having their properties edited are identified by ID. The ID parameter will be a string list of markup entity GUIDs delimited by '<|>'.
See Event MarkupEntityModified for more information about markup GUIDs.
The Property parameter will be a string version of the current property for each entity delimited by '<|>'.
Note that each entry in the ID list must have a corresponding entry in the Property list and the order of both lists is synchronized. A listener to this event may suppress the editing that the control normally allows a user to do by setting the value of CtrlHandle to zero. If CtrlHandle is set to zero, a listener may also edit the properties by changing the string values found in the Property parameter.
The Metadata parameter is currently not used.
Valid values for PropertyType:
BRAVAX_MRKPROP_HYPERLINK = 0
([in]long LinkType,
[in]BSTR ID,
[in]BSTR Metadata,
[in,out]long* CtrlHandle,
[in,out]BSTR* Target)
This event is fired just prior to the control launching a hyperlink.
The type of link being launched is indicated by the LinkType parameter. If the hyperlink is a property of a markup entity (LinkType = BRAVAX_MARKUP_HYPERLINK), ID will be the GUID identifier of that entity.
A listener to this event can suppress the launch of the link by setting the CtrlHandle parameter to 0.
A listener to this event can also edit the target of the link launched by modifying the string value of the Target parameter.
Valid values for LinkType:
BRAVAX_MARKUP_HYPERLINK = 2
BRAVAX_SOURCEDOC_HYPERLINK = 3
BRAVAX_SOURCEDOC_FILE = 5
RequestSaveViewAs(long type)
Fired when the user has attempted to save the current view to and alternate format (e.g. JPG) and RequestFileIOEvents property is TRUE. The parameter type indicates the desired alternate format. Currently only JPG is supported. See SaveViewAs section for details. The container is then responsible for prompting the user for an appropriate file name to save and then calling the method: SaveViewAs(fileName, type).
SaveViewAsFailure(BSTR Filename)
Fired when an attempt to save the current view to an alternate format (e.g. JPG) has failed. Property:ErrorMessage can be used for more information.
SaveViewAsSuccess(BSTR Filename)
Fired when an attempt to save the current view to an alternate format (e.g. JPG) has succeeded. Property:ErrorMessage can be used for more information.
PublishFailure(BSTR Filename,PublishOutputOptions option)
Fired when an attempt to convert the currently viewed document or drawing to CSF has failed. Property:ErrorMessage can be used for more information.
See PublishOutputOptions in BurnInFailure section for additional details.
PublishSuccess(BSTR Filename,PublishOutputOptions option)
Fired when an attempt to convert the currently viewed document or drawing to CSF has succeeded. Property:ErrorMessage can be used for more information.
See PublishOutputOptions in BurnInFailure section for additional details.
DisplayHelp(long contextID)
Fired when the user has requested a display of help information, and Proerty:RequestHelpDisplay is TRUE. The container is then responsible for displaying the help information that pertains to the given contextID. See Help Topic IDs Section for a list of acceptable contextIDs.
CDLEvent(long eventID)
Fired with and event ID to indicate on of the following occurrences:
NE_PAGECHANGED = 2
Indicates that the page of a drawing or document has changed.
NE_SOMETHINGISCOPYABLE = 7
Indicates that the MT_SOURCEDOC_SELECT mouse tool has selected text that can be copied to the system clipboard OR
Indicates that a markup entity has been selected.
NE_NOTHINGISCOPYABLE = 8
Indicates that a piece of text is no longer selected OR
Indicates that a markup entity has become unselected.
NE_SOMETHINGISPASTEABLE = 9
Indicates that a markup entity has been copied to the clipboard.
NE_NOTHINGISPASTEABLE = 10
Indicates that a markup entity is no longer availble from the clipboard.
NE_STARTEDEDITINGREDLINETEXT = 11
Indicates that a markup text entity has been created.
NE_STOPEDEDITINGREDLINETEXT = 12
Indicates that a markup text entity has been finalized.
NE_MOUSETOOLCHANGED = 15
Indicates that the mouse tool has changed. Property:MouseTool can be used to determine the currently active mouse tool.
NE_VIEW_CHANGED = 28
Fired when the view state of the document or drawing has changed. Note that this event is only fired if the Property:CollaborationMode has been set to TRUE.
NE_COPY_REGION_HAPPENED = 30
Indicates that a region of the document has been copied to the Clipboard.
CalibrationComplete()
Fired when the mouse tool is MT_CALIBRATE and the user has completed the calibration that is required to begin using other measurement tools.
(BSTR MarkupID)
This event is fired when any modification to a markup entity is finalized. This includes entity creation and deletion. MarkupID is a string used to uniquely identify the markup entity that was modified. MarkupID can then be used in subsequent calls to GetMarkupEntity and SetMarkupEntity.
This event is fired when the visibility of drawing layers are modified through the controls layer dialog.
([in] BSTR token, [in]BSTR parameter, [in,out]BSTR* result)
This event is fired when any banner or watermark contains a replacement token that can not be resolved. The unresolved token is provided in BSTR token and any accompanying parameter is provided in BSTR parameter. Listeners to this event can provide the token replacement value in BSTR* result.
([out] long *X, [out] long *Y,[out]long *MouseButtonID)
Fired when a mouse button is pressed while the cursor is over the control's view area. View coordinates are returned in X and Y. MouseButtonID indicates which mouse button was pressed:
LEFT_MOUSE_BUTTON_ID = 0
RIGHT_MOUSE_BUTTON_ID = 1
This event has been deprecated. Please use Event - ViewMouseEvent
([out] long *X, [out] long *Y,[out]long *MouseButtonID)
Fired when a mouse button is released while the cursor is over the control's view area. View coordinates are returned in X and Y. MouseButtonID indicates which mouse button was pressed:
LEFT_MOUSE_BUTTON_ID = 0
RIGHT_MOUSE_BUTTON_ID = 1
This event has been deprecated. Please use Event - ViewMouseEvent
(long *X,long *Y,BOOL LButtonDown,BOOL RButtonDown)
Fired when the mouse is moved while the cursor is over the control's view area. View coordinates are returned in X and Y. Current mouse button states are returned in LButtonDown and RButtonDown.
This event has been deprecated. Please use Event ViewMouseEvent
([in]long EventID,
[in]long X,
[in]long Y,
[in]BSTR Metadata)
This event is fired whenever any mouse activity happens while the cursor is within the document view area.
EventID indicates the type of mouse activity that has occurred. Valid values for EventID are:
BRAVAX_MOUSEEVENT_MOVE = 0
BRAVAX_MOUSEEVENT_ENTER = 1
BRAVAX_MOUSEEVENT_LEAVE = 2
BRAVAX_MOUSEEVENT_LEFTMOUSEBUTTONDOWN = 3
BRAVAX_MOUSEEVENT_LEFTMOUSEBUTTONUP = 4
BRAVAX_MOUSEEVENT_RIGHTMOUSEBUTTONDOWN = 5
BRAVAX_MOUSEEVENT_RIGHTMOUSEBUTTONUP = 6
BRAVAX_MOUSEEVENT_LEFTMOUSEBUTTONCLICK = 7
BRAVAX_MOUSEEVENT_RIGHTMOUSEBUTTONCLICK = 8
BRAVAX_MOUSEEVENT_LEFTMOUSEBUTTONDOUBLECLICK = 9
X and Y indicate the mouse position at the time of the event. X and Y are given in screen/pixel coordinates relative to the top-left corner of the control document view area.
Metadata is not currently used. This event is meant to replace BDTXMouseDown, BDTXMouseUp, and BDTXMouseMove
([in]BSTR ID,
[in]long EventID,
[in]long X,
[in]long Y,
[in]BSTR Metadata)
This event is fired whenever any mouse activity happens while the cursor is above a markup entity. ID uniquely identifies the markup entity. See Event MarkupEntityModified for more information about markup GUIDs.
EventID indicates the type of mouse activity that has occurred. Valid values for EventID are:
BRAVAX_MOUSEEVENT_MOVE = 0
BRAVAX_MOUSEEVENT_ENTER = 1
BRAVAX_MOUSEEVENT_LEAVE = 2
BRAVAX_MOUSEEVENT_LEFTMOUSEBUTTONDOWN = 3
BRAVAX_MOUSEEVENT_LEFTMOUSEBUTTONUP = 4
BRAVAX_MOUSEEVENT_RIGHTMOUSEBUTTONDOWN = 5
BRAVAX_MOUSEEVENT_RIGHTMOUSEBUTTONUP = 6
BRAVAX_MOUSEEVENT_LEFTMOUSEBUTTONCLICK = 7
BRAVAX_MOUSEEVENT_RIGHTMOUSEBUTTONCLICK = 8
BRAVAX_MOUSEEVENT_LEFTMOUSEBUTTONDOUBLECLICK = 9
X and Y indicate the mouse position at the time of the event. X and Y are given in screen/pixel coordinates relative to the top-left corner of the control document view area.
Metadata is not currently used
(BSTR Filename)
Fired when a currently open editable markup is saved to local disk. Filename indicates the save location.
Fired when the user has attempted to save a previously saved editable markup file - and RequestFileIOEvents property is TRUE. The container is then responsible for calling the method:SaveMarkup() to save the desired editable markup file.
Fired when the user has attempted to create a new editable markup file - and RequestFileIOEvents property is TRUE. The container is then responsible for calling the method:NewMarkup() to complete the creation of the editable markup file.
Fired when the user has attempted to close an editable markup file - and RequestFileIOEvents property is TRUE. The container is then responsible for calling the method:CloseMarkupEdit() to complete the closure of the editable markup file.
Fired when the user has attempted to close a review-only markup file - and RequestFileIOEvents property is TRUE. The container is then responsible for calling the method:CloseMarkupReview() to complete the closure of the review-only markup file.
This event is fired when a user has attempted to consolidate all markup entities currently existing in all markups open for review into a single editable markup - and RequestFileIOEvents property is TRUE. The container is then responsible for calling the method:ConsolidateMarkups() to complete the consolidation.
Fired when the user has attempted to create a new editable stamp template file - and RequestFileIOEvents property is TRUE. The container is then responsible for calling the method: NewMarkupStampTemplate() to complete the creation of the editable markup file.
Fired when the user has attempted to open an editable stamp template file - and RequestFileIOEvents property is TRUE. The container is then responsible for calling the method: OpenMarkupStampTemplate (BSTR fileName) to complete the opening of the editable stamp template file.
Fired when the user has attempted to save an editable stamp template file - and RequestFileIOEvents property is TRUE. The container is then responsible for calling the method: SaveMarkupStampTemplate () to complete the saving of the editable stamp template file.
Fired when the user has attempted to save an editable stamp template file to a new file name - and RequestFileIOEvents property is TRUE. The container is then responsible for calling the method: SaveAsMarkupStampTemplate (BSTR fileName) to complete the saving of the editable stamp template file.
Fired when the user has attempted to close an editable stamp template - and RequestFileIOEvents property is TRUE. The container is then responsible for calling the method: CloseMarkupStampTemplate () to complete the closing of the editable stamp template file.
(BSTR Filename)
Fired when an attempt to load a stamp template file has failed.
(BSTR Filename)
Fired when an attempt to load a stamp template file has succeeded.
(BSTR Filename)
Fired when a stamp template file has been saved.
(BSTR Filename)
Fired when a stamp template file has been closed.
Fired when a stamp template file has been created.
(BSTR Filename)
Fired when an attempt to load a stamp entity file into the stamp markup tool has failed.
(BSTR Filename)
Fired when an attempt to load a stamp entity file into the stamp markup tool has succeeded.
Fired when the user has attempted to instantiate the stamp markup tool with a new stamp file - and RequestFileIOEvents property is TRUE. The container is then responsible for setting the property MrkStampEntityFilename to the full path of a valid stamp file to complete the instantiation of the stamp markup tool.
Fired when the user has attempted to run a redaction script - and RequestFileIOEvents property is TRUE. The container is then responsible for calling the method:RedactFromScript to provide a redaction script.
Fired when the user has attempted to copy a remote file to a local file - and RequestFileIOEvents property is TRUE. The container is then responsible for calling the method:DownloadOriginalToLocalFile to provide a file name to take the contents of the remote file.
Fired when the user has attempted to create a PDF rendition of the currently open drawing or document - and RequestFileIOEvents property is TRUE. The container is then responsible for calling the method:ExportPDF to provide a file name to be used for the PDF rendition.
Fired when the user has attempted to create a TIFF rendition of the currently open drawing or document - and RequestFileIOEvents property is TRUE. The container is then responsible for calling the method:ExportTiffEx to provide a file name to be used for the TIFF rendition
Fired when the user has attempted to create a DWF rendition of the currently open drawing or document - and RequestFileIOEvents property is TRUE. The container is then responsible for calling the method:ExportDWF to provide a file name to be used for the DWF rendition
Fired when the user has attempted to use the raster markup tool and there is no raster file selected for the tool - and RequestFileIOEvents property is TRUE. The container is then responsible for calling the property:RasterMrkFilename to provide a raster file to be used in the raster markup tool.
(BSTR Filename)
Fired when the control was unable to copy the contents of remote file to local file.
(BSTR Filename)
Fired when the control succeeded in copying the contents of a remote file to a local file.
(BSTR Filename)
Fired when the control was unable to open a document or drawing for compare.
(BSTR Filename)
Fired when the control succeeded in opening a document or drawing for compare.
(BSTR Filename)
Fired when the control has closed a document or drawing open for compare.
(BSTR Filename)
Fired when the control was unable to create a PDF rendition of the currently open drawing or document.
(BSTR Filename)
Fired when the control succeeded in creating a PDF rendition of the currently open drawing or document.
(BSTR Filename)
Fired when the control was unable to create a TIFF rendition of the currently open drawing or document.
(BSTR Filename)
Fired when the control succeeded in creating a TIFF rendition of the currently open drawing or document.
(BSTR Filename)
Fired when the control was unable to create a DWF rendition of the currently open drawing or document.
(BSTR Filename)
Fired when the control succeeded in creating a DWF rendition of the currently open drawing or document.
(BSTR Filename)
Fired when the control was unable to open a raster file for use with the raster markup tool.
(BSTR Filename)
Fired when the control succeeded in opening a raster file for use with the raster markup tool.
([in] long MessageID, [in]BSTR MessageText, [in,out]long* Display)
Fired just prior to the control displaying an error or information message. The message is identified by MessageID. See MessageID section for a list of possible values. MessageText will contain the text that will appear in the message dialog. If a container sets the value of Display to 0, the message will not be displayed.
(long EventID)
Fired when the controls windows are created. Parameter EventID is not currently used.
(BOOL BurningMarkup)
This event is only fired if the property UseStandardCSFOutput has been set to TRUE. Fired when the user has attempted to create a CSF rendition of the currently open drawing or document, RequestFileIOEvents property is TRUE. The container is then responsible for calling the method: ExportCSF to provide a file name to be used for the CSF rendition.
([in,out]long* Continue)
This event is fired immediately before the control copies something (e.g. text, markup entity) to the Windows Clipboard. A listener to this event can cause the copy to not be performed if the parameter Continue is set to 0.
([in,out]long* Continue)
This event is fired immediately before the control pastes something (e.g. text, markup entity) from the Windows Clipboard. A listener to this event can cause the paste to not be performed if the parameter Continue is set to 0.
This event is fired immediately after the control has completed a copy to clipboard command.
This event is fired immediately after the control has completed a paste from clipboard command.
This event applies when the control is receiving drawings and documents from the Brava server. In some cases, files being published by the Brava Server will be sent to the Brava Viewer control before the server has completely published the file. In these cases, this event will be fired after the server has completed the entire publishing job.
This event is fired when the control has completed the spooling of a document to a printer.
(BSTR Info, BSTR EntityData, long* DisplayInfo)
Fired when a metadata entity such as a AutoCad Block is clicked while the Selection or Pan tools are active. The Info parameter will be a string containing information about the entity clicked. The EntityData parameter is not currently used. If a listener to this event sets the value of DisplayInfo to 0, the control will not display the message box containing the string Info.
(BSTR Info, BSTR EntityData, long* DisplayInfo)
Fired when a metadata entity such as an AutoCad Block is hovered over while the Selection or Pan tools are active. The Info parameter will be a string containing information about entity hovered. The EntityData parameter is not currently used. If a listener to this event sets the value of DisplayInfo to 0, the control will not display the pop-up message box containing the string Info.
(BSTR CMID)
Fired when a Changemark entity is either selected from the Changemark review panel, clicked on with the selection tool active, or executed via Method ExecuteChangemark. CMID is a unique identifier for the Changemark executed.
BRAVAX_UNSPECIFIED_ERROR = 1,
BRAVAX_INVALID_DLFILE_EXT = 2,
BRAVAX_INVALID_XDLFILE = 3,
BRAVAX_INVALID_PAGENUMBER = 4,
BRAVAX_CANT_READ_PAGE = 5,
BRAVAX_CANT_LOCALIZE_FILE = 6 BRAVAX_INVALID_ELEMENT_RECORD = 7, BRAVAX_CANT_CONSTRUCT_IO_CLASS = 8, BRAVAX_INVALID_FILE_ID_TAG = 9, BRAVAX_CANT_WRITE_DLPAGE = 10, BRAVAX_INVALID_MRKFILE_EXT = 11, BRAVAX_CANT_READ_MRKFILE = 12, BRAVAX_FUTURE_CDL_FILE_FORMAT = 13, BRAVAX_FUTURE_MRK_FILE_FORMAT = 14, BRAVAX_FORMAT_NOT_LICENSED = 15, BRAVAX_LOADER_NOT_FOUND = 16, BRAVAX_NO_PRINTER = 17, BRAVAX_CANT_FIND_SUPPORT_FILE = 18, BRAVAX_CANT_FIND_XREF_FILE = 19, BRAVAX_INTEGRATION_ERROR = 20, BRAVAX_FILELOAD_ERROR = 21, BRAVAX_MRKLOAD_ERROR = 22, BRAVAX_RASTERMRKLOAD_ERROR = 23, BRAVAX_INVALID_REDACTION_SCRIPT_ERROR = 24,
BRAVAX_CANT_RESOLVE_MRKFILE = 25,
BRAVAX_INTEGRATION_ERROR_INITIALIZATION = 26,
BRAVAX_INTEGRATION_ERROR_CLIENTID = 27,
BRAVAX_INTEGRATION_ERROR_FROM_SERVER = 28,
BRAVAX_NATIVEFILE_INCORRECT_PASSWORD = 29,
BRAVAX_MRKSTAMPENTITYLOAD_ERROR = 30,
BRAVAX_INTERNALREFERENCEFILELOAD_ERROR = 31,
BRAVAX_DOTNET3_NOT_INSTALLED_ERROR = 32,
BRAVAX_FUTURE_STAMP_FILE_FORMAT = 33,
BRAVAX_CANT_READ_STAMPFILE = 34,
BRAVAX_NATIVE_FILE_IS_PROTECTED = 35,
BRAVAX_CANT_WRITE_FILE = 36
BRAVAX_SR_INCORRECT_PASSWORD = 101, BRAVAX_SR_FILE_EXPIRED = 102, BRAVAX_SR_INVALID_FILE = 103, BRAVAX_SR_3D_SCF = 104, BRAVAX_SR_START_DATE_LATER = 105, BRAVAX_SR_REDACTION_PASSWORD = 106, BRAVAX_SR_YOU_CHEATED = 107, BRAVAX_INVALID_LICENSE = 200, BRAVAX_LICENSE_EXPIRED = 201, BRAVAX_LM_REQUEST_RESULT_FAILED = 202, BRAVAX_LM_REQUEST_RESULT_REVOKED = 203, BRAVAX_LM_REQUEST_RESULT_EXPIRED = 204, BRAVAX_LM_REQUEST_RESULT_NO_SEATS_AVAILABLE = 205, BRAVAX_LM_REQUEST_RESULT_GENERAL_ERROR = 206, BRAVAX_LM_REQUEST_RESULT_COMMUNICATION_ERROR = 207, BRAVAX_REGISTER_LICENSE_NO_INTERNET_CONNECTION = 208, BRAVAX_REGISTER_LICENSE_UNABLE_TO_CONTACT_HOST = 209, BRAVAX_REGISTER_LICENSE_UNABLE_TO_GENERATE_REQUEST_INFO = 210, BRAVAX_REGISTER_LICENSE_COULD_NOT_RETRIEVE_RESPONSE = 211, BRAVAX_REGISTER_LICENSE_INVALID_RESPONSE_FROM_HOST = 212, BRAVAX_REGISTER_LICENSE_LICENSE_VERIFICATION_FAILED = 213, BRAVAX_REGISTER_LICENSE_GENERAL_ERROR = 214, BRAVAX_REGISTER_LICENSE_UNABLE_TO_UPDATE_LICENSE_LOCALLY = 215, BRAVAX_REGISTER_LICENSE_ALREADY_REGISTERED = 216, BRAVAX_REGISTER_LICENSE_HOST_UNABLE_TO_DECODE_LICENSE = 217, BRAVAX_REGISTER_LICENSE_HOST_DATABASE_UPDATE_FAILED = 218, BRAVAX_REGISTER_LICENSE_HOST_UNABLE_TO_REENCODE_LICENSE = 219, BRAVAX_REGISTER_LICENSE_HOST_UNABLE_TO_GENERATE_PIN = 220, BRAVAX_REGISTER_LICENSE_HOST_UNABLE_TO_GENERATE_DEMO_LICENSE = 221, BRAVAX_NO_DESIGNTIME_LICENSE = 222, BRAVAX_COULD_NOT_ACCESS_LICENSE_FILE = 223
BRAVAX_INVALID_LICENSE_FROM_BRAVA_SERVER = 224,
BRAVAX_LICENSE_EXPIRATION_WARNING_PERIOD = 225
The following are the integer identifiers for all customizable controls:
IDC_COMBO_PAGE 233
ID_BUTTON_ROTATION 32779
ID_BUTTON_LAYERS 32780
ID_BUTTON_MONOCHROME 32781
ID_BUTTON_BACKCOLOR 32782
ID_BUTTON_PREVPAGE 32783
ID_BUTTON_NEXTPAGE 32784
ID_BUTTON_PAN 32768
ID_BUTTON_ZOOMWIN 32769
ID_BUTTON_ZOOM 32770
ID_BUTTON_MAGNIFIER 32771
ID_BUTTON_SHOWTHUMBNAILS 32875
ID_BUTTON_ABOUT 32772
IDC_COMBO_TB_SCALE 344
ID_BUTTON_MARKUP 32773
ID_BUTTON_MARKUPSAVE 32903
ID_BUTTON_PRINT 32774
ID_BUTTON_MEASURE 32775
ID_BUTTON_SELECT 32776
ID_BUTTON_EXTENTS 32777
ID_BUTTON_WIDTH 32778
ID_BUTTON_DOWNLOADORIGINAL 32836
ID_BUTTON_SAVEAS 32840
ID_MRKTOOL_SELECT 503
ID_MRKTOOL_ARROW 505
ID_MRKTOOL_TEXT 507
ID_MRKTOOL_CHANGEMARK 509
ID_MRKTOOL_RASTERFILE 880
ID_MRKTOOL_STAMPFILE 1158
ID_MRKTOOL_CLOUD 511
ID_MRKTOOL_SKETCH 514
ID_MRKTOOL_LINE 517
ID_MRKTOOL_SHAPE 520
ID_MRKTOOL_REDACT 522
ID_MRKTOOL_TEXTMODIFY 523
ID_MRKTOOL_HYPERLINK 512
ID_MENU_MEASURE_CALIBRATE 32785
ID_MENU_MEASURE_SETTINGS 32789
ID_MENU_MEASURE_LINE 32950
ID_MENU_MEASURE_POLYLINE 32951
ID_MENU_MEASURE_POLYGON 32952
ID_MENU_MEASURE_RECT 32953
ID_MENU_MEASURE_CIRCLE 32954
ID_MENU_MEASURE_COUNT 32955
ID_MENU_ISOBANNER_DATE 32790
ID_MENU_ISOBANNER_SYSDATEPLUSDAYS 32791
ID_MENU_ISOBANNER_TIME 32792
ID_MENU_ISOBANNER_MILTIME 32793
ID_MENU_ISOBANNER_TITLE 32794
ID_MENU_ISOBANNER_PAGES 32795
ID_MENU_ISOBANNER_TOTALPAGES 32796
ID_MENU_ISOBANNER_BATESPGNO 32985
ID_MENU_ISOBANNER_LOGIN 32797
ID_MENU_ISOBANNER_USER 32798
ID_MENU_ISOBANNER_PERCENT 32799
ID_MENU_ISOBANNER_DBSTRING 32855
ID_MENU_FIND_DOWN 32801
ID_MENU_FIND_UP 32802
ID_MENU_FIND_MATCHCASE 32803
ID_MENU_RP_BACKVIEW 32890
ID_MENU_RP_FITALL 32809
ID_MENU_RP_FITWIDTH 32810
ID_MENU_RP_PANTOOL 32877
ID_MENU_RP_VIEWPINPOP 32885
ID_MENU_RP_ADDVIEWPIN 32886
ID_MENU_RP_NEXTVIEWPIN 32887
ID_MENU_RP_REMOVEALLVIEWPINS 32889
ID_MENU_RP_REVIEWCM 32811
ID_MENU_RP_PAGECTRLPOP 32892
ID_MENU_RP_NEXTPAGE 32819
ID_MENU_RP_PREVPAGE 32818
ID_MENU_RP_PAGECTRLFIRST 32894
ID_MENU_RP_PAGECTRLLAST 32893
ID_MENU_RP_PREVMRK 32823
ID_MENU_RP_NEXTMRK 32824
ID_MENU_RP_COPYREGION 32883
ID_MENU_RP_COPY 32813
ID_MENU_RP_PASTE 32814
ID_MENU_RP_DELETE 32815
ID_MENU_RP_UNDO 32870
ID_MENU_RP_REDO 32871
ID_MENU_RP_ROTATEMIRRORPOP 32882
ID_MENU_RP_ROTATECLOCKWISE 32880
ID_MENU_RP_ROTATECOUNTERCLOCKWISE 32881
ID_MENU_RP_MIRROR 32841
ID_MENU_RP_BKCOLORPOP 32865
ID_MENU_RP_BKCOLORPOP_BLACK 32851
ID_MENU_RP_BKCOLORPOP_WHITE 32852
ID_MENU_RP_BKCOLORPOP_GRAY 32853
ID_MENU_RP_BKCOLORPOP_DEFAULT 32854
ID_MENU_RP_OPTIONSPOP 32884
ID_MENU_RP_ANIMATE 32817
ID_MENU_RP_LINEWTS 32842
ID_MENU_RP_ANTIALIAS 32856
ID_MENU_RP_SHOWTHUMBNAILS 32869
ID_MENU_MRK_OPENREVIEW 32820
ID_MENU_MRK_CLOSEREVIEW 32821
ID_MENU_MRK_REVIEWCM 32822
ID_MENU_MRK_PREVMRK 32825
ID_MENU_MRK_NEXTMRK 32826
ID_MENU_MRK_NEWEDIT 32827
ID_MENU_MRK_OPENEDIT 32828
ID_MENU_MRK_SAVEEDIT 32829
ID_MENU_MRK_SAVEDXFEDIT 32830
ID_MENU_MRK_CLOSEEDIT 32831
ID_MENU_MRK_SAVEASEDIT 32832
ID_MENU_MRK_CONSOLIDATE 32833
ID_MENU_MRK_REVIEW_MRK_PAGES 32863
ID_MENU_MRK_STAMPTEMPLATEPOP 32897
ID_MENU_MRK_NEWSTAMPTEMPLATE 32898
ID_MENU_MRK_OPENSTAMPTEMPLATE 32899
ID_MENU_MRK_SAVESTAMPTEMPLATE 32900
ID_MENU_MRK_SAVEASSTAMPTEMPLATE 32901
ID_MENU_MRK_CLOSESTAMPTEMPLATE 32902
ID_MENU_MRKTEXTBACKGROUND_SELECT 32965
ID_MENU_MRKTEXTBACKGROUND_TRANSPARENT 32966
ID_MENU_MRKTEXTBACKGROUND_OPAQUE 32967
ID_MENU_MRKTEXTBACKGROUND_CURRENT 32968
ID_MENU_HELPABOUT_CONTENTS 32837
ID_MENU_HELPABOUT_ABOUT 32838
ID_MENU_HELPABOUT_SUGGEST 32839
ID_MENU_PRINT_PRINTDLG 32843
ID_MENU_PRINT_PRINTRGN 32844
ID_MENU_PRINT_BANNEREDIT 32845
ID_MENU_BKCOLORPOP_BLACK 32847
ID_MENU_BKCOLORPOP_WHITE 32848
ID_MENU_BKCOLORPOP_GRAY 32849
ID_MENU_BKCOLORPOP_DEFAULT 32850
ID_MENU_SAVEAS_CSFPUBLISH 32866
ID_MENU_SAVEAS_PDFPUBLISH 32867
ID_MENU_SAVEAS_TIFFPUBLISH 32876
ID_MENU_SAVEAS_DWFPUBLISH 32896
ID_MENU_SAVEAS_SAVEASJPG 32868
ID_MENU_THUMB_REDUCE 32872
ID_MENU_THUMB_ENLARGE 32873
ID_MENU_THUMB_DEFAULT_SIZE 32874
|
#define BACKGROUND_FILLS | |
|
#define CREATING_CUSTOM_MACROS | |
|
#define SCRIPT_EDITING_FOR_ADVANCED_USERS | |
|
#define WILDCARD_HINTS_AND_EXAMPLES | |
|
#define BURNED_IN_MARKUPS | |
|
#define CLOSING_MARKUPS | |
|
#define ALLTOOLBARS | |
|
#define WATERMARK1 | |
|
#define ARC | |
|
#define BACKGROUND_COLOR | |
|
#define BLOCK_OUT | |
|
#define STARTEXPIRE | |
|
#define DISPLAY_OPTIONS | |
|
#define DOCUMENT_PAGE_CONTROL | |
|
#define CHANGEMARKS_FILTERS | |
|
#define EDIT_TEXT | |
|
#define SET_BATES_NUMBER | |
|
#define CONTACT_INFORMATION | |
|
#define FIT_ALL | |
|
#define CREATING_CHANGEMARKS | |
|
#define CREATING_MARKUPS | |
|
#define CROSSOUT | |
|
#define HOTKEYS | |
|
#define HYPERLINK | |
|
#define IMAGE_BASED | |
|
#define ISO_BANNERS | |
|
#define EDITABLE_MARKUPS | |
|
#define LINE_ARROW | |
|
#define LINE1 | |
|
#define LINETHICKNESS | |
|
#define MAGNIFY | |
|
#define MARKUP_COLOR | |
|
#define MARKUP_FILES | |
|
#define MARKUP_FONT | |
|
#define MARKUP_LINE_WIDTH | |
|
#define MARKUP_PAGES | |
|
#define MARKUP_PROPERTIES | |
|
#define MARKUP_TOOLBAR | |
|
#define MEASURE | |
|
#define MEASURE_COUNT | |
|
#define MEASUREMENT_SETTINGS | |
|
#define MONOCHROME | |
|
#define OVERLAY_MARKUPS_FOR_REVIEW | |
|
#define PAGE_CONTROL | |
|
#define PAN | |
|
#define POLYGON | |
|
#define POLYLINE | |
|
#define PRINT | |
|
#define PRINT_A_FILE | |
|
#define PRINT_REGION | |
|
#define PRINT_TIPS_AND_TROUBLESHOOTING | |
|
#define PRINT_TO_SCALE | |
|
#define REVIEWING_CHANGEMARKS | |
|
#define ROTATE | |
|
#define SAVING_MARKUPS | |
|
#define SCRATCH | |
|
#define SEARCH | |
|
#define SELECT_ENTITY_TOOL | |
|
#define SELECT_TOOL | |
|
#define SKETCH | |
|
#define SOLID_AND_HOLLOW_SHAPES | |
|
#define STANDARD_TOOLBAR | |
|
#define STATUS_BAR | |
|
#define TAGS | |
|
#define VIEW_TOOLS | |
|
#define VISIBLE_LAYERS | |
|
#define WATERMARK | |
|
#define WELCOME_TO_BRAVA_ | |
|
#define ZOOM_AND_PAN_TOOLS | |
|
#define ZOOM_WINDOW | |
|
#define RIGHTMOUSE | |
|
#define PUBLISHING_WITH_BRAVA_DESKTOP | |
|
#define CREATE_CSF | |
|
#define WHAT_IS_CSF_ | |
|
#define UPDATE_VERSION | |
|
#define MIRROR | |
|
#define SAVE_VIEW | |
|
#define DOWNLOADING_TOOL | |
|
#define OPEN_FOR_COMPARISON | |
|
#define WHY_CSF_ | |
|
#define SET_PATHS | |
|
#define SEND_FILE | |
|
#define MEASURE_POLYLINE | |
|
#define FILE_TYPES | |
|
#define ALIGN_COMPARISON_TOOL | |
|
#define FIND_AND_REDACT | |
|
#define PUBLISHING_MARKUPS_TO_PDF_FILES | |
|
#define MEASURE_MAGNIFICATION_TOOL | |
|
#define INSERT_RASTER_IMAGE | |
|
#define REDACT_BY_SCRIPT | |
|
#define REDACT_MOUSE_TOOL | |
|
#define PUBLISHING_FILES_TO_PDF | |
|
#define BURNING_IN_MYRIAD_MARKUPS | |
|
#define BRAVA_DESKTOP_SKU_S | |
|
#define THUMBNAIL_PAGES | |
|
#define PUBLISHING_FILES_TO_DWF | |
|
#define PUBLISHING_FILES_TO_TIFF | |
|
#define PUBLISHING_FILES | |
|
#define BOOKMARKS | |
|
#define CUSTOMIZATION | |
|
#define CIRCLE | |
|
#define EXTRACT_CHANGEMARKS | |
|
#define MARKUP_STAMP | |
|
#define STAMP_TEMPLATES | |
|
#define MARKUP_TEXT_BACKGROUND | |
|
#define VIEWXPS_IDW | |
|
#define USING_SEARCH_MACROS | |
|
#define CALIBRATE | |
|
#define SECURITY_TYPE | |
|
#define SEARCH_WILDCARD_FORMATTING | |
|
#define REDACTION | |
|
#define VERIFYREDACTIONS | |
|
#define EDITING_MARKUPS | |
|
#define AUTOMATION_FEATURES | |
|
#define FIT_WIDTH | |
|
#define FONT_CHOOSER | |
|
#define WILDCARD_QUICK_TIPS | |
|
#define HIDES | |
|
#define LINE | |
|
#define HIGHLIGHTS | |
|
#define OPEN_A_DOCUMENT1 | |
|
#define NEW_FEATURES | |
|
#define DLTEXT | |
|
#define RECTANGLE | |
|
#define CLOUD | |
|
#define VIEW_CSF | |
|
#define COPY_TEXT | |
|
#define LAUNCH_AUTOCAD | |
|
#define COPY_REGION | |
|
#define EXPIRATION_DATES | |
|
#define MEASURE_POLYLINE1 | |
|
#define PERMISSIONS | |
|
#define CONSOLIDATING_MARKUPS | |
|
#define CHANGING_MARKUP_OWNERSHIP | |
|
#define COPYING_MARKUPS | |
|
#define USER_PERMISSIONS | |
|
#define FEATURE_AVAILABLILTY | |
|
#define REDACTION_CARVING_TOOL |
The following properties can be set via html parameters:
Filename
RequestFileIOEvents
RequestFileIOIntegration
MrkReviewFilename
MrkEditFilename
CurrentPageNumber
SearchText
DisplayName
UserName
DateFormat
TimeZone
AllowFileOpen
AllowPrinting
AllowMarkup
AllowMeasurement
AllowLayers
AllowFind
AllowCopyText
AllowMrkSaveAsDXF
AllowMrkSaveAs
AllowMrkSave
AllowMrkOpen
AllowMrkNew
AllowPageControl
AllowRotate
AllowBKColor
AllowMonochrome
EnableMarkupColorPalette
MarkupColor
WatermarkBannerFontName
WatermarkBannerFontStyle
BannerFontSize
ScreenBanner
ScreenWatermark
Watermark
TopLeft
TopCenter
TopRight
BottomLeft
BottomCenter
BottomRight
LeftTop
LeftCenter
LeftBottom
RightTop
RightCenter
RightBottom
To be used with the EnableAcceleratorKey method.
|
Combination |
Action |
KeyID Value |
|
CTRL + A |
Show about | |
|
CTRL + SHIFT + A |
Change to pan tool | |
|
CTRL + SHIFT + B |
Burn in markup | |
|
CTRL + ALT + B |
Add a bookmark | |
|
CTRL + B |
Toggle through bookmarks | |
|
ALT + B |
Toggle through background colors | |
|
CTRL + C |
Copy selected | |
|
CTRL + SHIFT + C |
Close editable markup | |
|
CTRL + SHIFT + D |
Export PDF | |
|
CTRL + E |
Fit all | |
|
CTRL + F |
Mirror raster | |
|
CTRL + SHIFT + F |
Export DWF | |
|
CTRL + G |
Set print region tool | |
|
CTRL + H |
Show help | |
|
CTRL + SHIFT + J |
Save View as JPG | |
|
CTRL + K |
Export CSF | |
|
CTRL + L |
Show Layer dialog | |
|
CTRL + M |
Open editable markup | |
|
CTRL + N |
New editable markup | |
|
CTRL + O |
Open file | |
|
CTRL + P |
Show print dialog | |
|
CTRL + R |
Open review markup | |
|
CTRL + SHIFT + R |
Close review markup | |
|
CTRL + S |
Save editable markup | |
|
CTRL + SHIFT + S |
SaveAs editable markup | |
|
CTRL + T |
Toggle thumbnail display | |
|
CTRL + SHIFT + T |
Export TIFF | |
|
CTRL + V |
Paste | |
|
CTRL + W |
Fit width | |
|
CTRL + X |
Delete | |
|
CTRL + SHIFT + X |
Change to zoom tool | |
|
CTRL + Y |
Redo | |
|
CTRL + Z |
Undo | |
|
CTRL + SHIFT + Z |
Change to magnifier tool | |
|
CTRL + SPACE |
Rotate 90 degrees clockwise | |
|
CTRL + SHIFT + SPACE |
Rotate 90 degrees counter-clockwise | |
|
Page Up |
Previous page | |
|
CTRL + Page Up |
Previous markup page | |
|
Page Down |
Next page | |
|
CTRL + Page Down |
Next markup page | |
|
End |
Last page | |
|
Home |
First page | |
|
CTRL + ALT + LeftArrow |
Back View | |
|
CTRL + ALT + RightArrow |
Forward View | |
|
CTRL + LeftArrow |
Nudge compare view left | |
|
CTRL + UpArrow |
Nudge compare view up | |
|
CTRL + RightArrow |
Nudge compare view right | |
|
CTRL + DownArrow |
Nudge compare view down | |
|
CTRL + Tab |
Toggle older and newer compare docs | |
|
F3 |
Find Next Search string instance |
|
Politica de confidentialitate | Termeni si conditii de utilizare |
Vizualizari: 1990
Importanta: 
Termeni si conditii de utilizare | Contact
© SCRIGROUP 2024 . All rights reserved
