#### AutoVueX Control Properties, Methods and Events

#### AvMarkupX Control Properties, Methods and Events

#### AvPrintX Control Properties, Methods and Events

####

#### AutoVue CompareX Control Properties, Methods and Events

## AutoVueX control

### Properties:

BSTR SRC

Source file path

boolean ShowScrollBars

Flag that indicates whether to show Scrollbars or not

boolean ShowMainToolBar

Flag that indicates whether to show Main Toolbar or not

boolean ShowAuxiToolBar

Flag that indicates whether to show Auxiliary Toolbar or not

boolean ShowStatusBar

Flag that indicates whether to showStatus Bar or not

boolean EnablePopupMenu

Flag that indicates whether to enable Popup Menu or not

boolean MrkMainToolbar

flag that indicates whether to show Markup MainToolbar or not

boolean MrkPensToolbar

flag that indicates whether to show Markup PensToolbar or not

boolean MrkEntitiesToolbar

flag that indicates whether to show Markup EntitiesToolbar or not

boolean MrkColorsToolbar

flag that indicates whether to show Markup ColorsToolbar or not

BSTR MrkFileLocation

Directory where markup files are stored

OLE_COLOR BgColor

Background color

short Rotate

Specifies current rotation value

Can be only 0,90, 180, 270

short Flip

0 - No flipping

1 - Flip horizontal

2 - Flip vertical

3 - Flip both

short Page

Specifies current page

short Extents

0 - Unchanged,

1 - Fit,

2 - Fit Width,

3 - Custom, following 4 properties are used to determine the extents

double ExtMinX

Minimal X coordinate of extents

double ExtMinY

Minimal Y coordinate of extents

double ExtMaxX

Maximal X coordinate of extents

double ExtMaxY

Maximal Y coordinate of extents

### Methods:

void SetContrast(long contrastValue)

Set the image contrast to be the specific value, this only applies to raster files

void GetContrast()

Return the image contrast value.The value can be one of the following for the raster file
CONTRAST_LIGHT (-50)
CONTRAST_MEDIUM (0)
CONTRAST_DARK (66)
CONTRAST_DARKER (100)

void SetAntiAlias()
Scale to grey, enhances the details of the raster file image that are viewed at less than 100% zoom.

void ShowLayersDlg()
Display the layer dialog

void ShowBlocksDlg()
Display the block dialog

void ShowNamedViewsDlg()
Display the named view dialog

void ShowXRefDlg()
Display the X Reference dialog

void ZoomFit()

Zoom to fit

void ZoomPrevious()

Undo last zoom operation

void ZoomWidth()

Zoom to fit width

void ZoomHeight()

Zoom to fit height

void ZoomByFactor(doublefactor)

Zoom by factor

Parameters

factor - zooming factor

void ZoomFullResolution()

Displays rasters using full resolution, for other formats same as ZoomFit

void PrintIt( boolean bPrintDirect)

Print current document

Parameters

bPrintDirect -flag that indicates whether to show a dialog box to user or not

void PrintPreview( boolean bPreviewDirect,boolean bWantFrame)

Preview current document printing

Parameters

bPreviewDirect- flag that indicates whether to show a dialog box to user or not

bWantFrame - flag for preview with frame or not

void SetPrintOptions( BSTR sEntry,BSTR sValue)

Set print options, call this method prior to call PrintIt or PrintPreview to set print options

Parameters

sEntry- specify which print option to set. Currently the following options are supported:

PRINT_OPT_ORIENTATION-Set print page orientation

PRINT_OPT_DISABLE_HEADERSFOOTERS-disable/enable headers/footers print option

PRINT_OPT_DISABLE_WATERMARK-disable/enable watermark print option

PRINT_OPT_DISABLE_MARGINS-disable/enable margin print option

PRINT_OPT_DISABLE_STAMPS-disable/enable stamp print option

PRINT_OPT_DISABLE_PENSETTINGS-disable/enable pen setting print option

PRINT_OPT_DISABLE_PRINTTOFILE-disable/enable print to file print option

PRINT_OPT_DISABLE_PRINT-disable/enable print function

ALIGNMENT – printing alignment

PRINTOFFSETX – x offset when ALIGNMENT is set to “CUSTOM”

PRINTOFFSETY – y offset when ALIGNMENT is set to “CUSTOM”

PRINT1PAGEONLY – disable/enable print only one page print option

LH - specify text for header (left)

CH - specify text for header (center)

RH - specify text for header (right)

LF - specify text for footer (left)

CF - specify text for footer (center)

RF - specify text for footer (right)

AREA – Specify print area

SCALE – Set n% to the scale value

UNITS – Specify units

OUTPUTFILE – Specify output file name (When printing to a file)

ORIENTATION – Specify orientation

PAGERANGE – Specify page range

FORCETOBLACK – Specify if you want to force all colors to black

PRINTDRIVER – Specify the print device to use

PAPERSIZE - Specify the paper size

PDFPAPERSIZE – Specify paper size when printing to PDF through AutoVue Document Converter.

sValue - option values. Valid values are dependent on each specific print option entry

PRINT_OPT_ORIENTATION

PORTRAIT-Set print page orientation as portrait

LANDSCAPE-Set print page orientation as landscape

PRINT_OPT_DISABLE_HEADERSFOOTERS

TRUE-Disable headers/footers print option

FALSE-Enable headers/footers print option

PRINT_OPT_DISABLE_WATERMARK

TRUE-Disable watermark print option

FALSE-Enable watermark print option

PRINT_OPT_DISABLE_MARGINS

TRUE-Disable margin print option

FALSE-Enable margin print option

PRINT_OPT_DISABLE_STAMPS

TRUE-Disable stamp print option

FALSE-Enable stamp print option

PRINT_OPT_DISABLE_PENSETTINGS

TRUE-Disable pen setting print option

FALSE-Enable pen setting print option

PRINT_OPT_DISABLE_PRINTTOFILE

TRUE-Disable print to file print option

FALSE-Enable print to file print option

PRINT_OPT_DISABLE_PRINT

TRUE-Disable print function

FALSE-Enable print function

ALIGNMENT

One of the following value:

CUSTOM | TOPLEFT | TOPLEFT | TOPCENTER | TOPRIGHT |

MIDDLELEFT | CENTER | MIDDLERIGHT | BOTTOMLEFT |

BOTTOMCENTER | BOTTOMRIGHT

PRINTOFFSETX

PRINTOFFSETY

Value in printing unit

PRINT1PAGEONLY

1 – Enable option

0 – Disable option

LH, CH, RH, LF, CF, RF – Text for header/footer

AREA

DISPLAY – Current display

EXTENTS – Extents of the drawing

SCALE

n% - Scale value e.g. “100%”

UNITS

INCH – Inch

MM – mm

PIXEL – Pixel

OUTPUTFILE

<full path> - Output file path e.g. “c:\output.pdf”

ORIENTATION

L – Landscape

P – Portrait

PAGERANGE

n-m – Page range e.g. “1-3”

FORCETOBLACK

TRUE – Enable force to black

FALSE – Disable force to black

PRINTDRIVER

<driver name> - Print driver name e.g. “AutoVue Document Converter”

PAPERSIZE

n - Paper size ID. Paper size specified must be supported by your printer. Note: For updated paper size values, refer to wingdi.h that is part of the MSDN distribution.

PDFPAPERSIZE

AUTO – Auto detect paper size when printing to PDF through AutoVue Document Converter

long GetVcetHandle()

Return Value
Returns handle of the VCET window

boolean EnterMarkupMode()

Enter Markup Mode

Return value

TRUE - entered Markup Mode successfully

FALSE - otherwise

boolean ExitMarkupMode()

Exit Markup Mode

Return Value

TRUE - exited Markup Mode successfully

FALSE - user canceled operation

IDispatch * MrkObj()

Return Value
Returns pointer to AvMarkupX object if in markup mode

otherwise returns NULL

IDispatch * PrnObj()

Return Value
Returns pointer to AvPrintX object if in print preview mode

otherwise returns NULL

short GetMode()

Return Value
Returns current mode

0 - View Mode

1 - Markup Mode

2 - Print Preview Mode

void PageNext()

Display next page

void PagePrevious()

Display previous page

void PageSelect()

Select page number

boolean GetMousePos( double* pPosX, double* pPosY)

Return Value
TRUE if mouse in the window rectangle, FALSE - otherwise

Parameters
*pPosX - X coordinate of mouse position

*pPosY - Y coordinate of mouse position

void ZoomInWorld( double MinX, double MinY, double MaxX, double MaxY)

Zoom box. The box is specified in world coordinate

Parameters
MinX - The x-coordinate of the low-left corner of a zoom box

MinY - The y-coordinate of the low-left corner of a zoom box

MaxX - The x-coordinate of the upper-right corner of a zoom box

MaxY - The y-coordinate of the upper-right corner of a zoom box

boolean SetLicenseFilePath( BSTR sLicPath)

Set path environment variable for AutoVueX OCX control

Return Value
TRUE if the path environment variable is set, FALSE - otherwise

Parameters
sLicPath - the path where the AutoVueX OCX is located

boolean EnableMarkup( boolean fEnable)

Enable or disable markup function

Return Value
The previous markup status.

Parameters
fEnable - Enable markup if TRUE, disable it otherwise

void EnablePanMode( boolean bEnable)

Enable or disable Pan Mode

Parameters
bEnable – Flag that indicates to turn on Pan Mode or not

long GetNumCrossProbeEntities()

Return Value

Returns number of entities being cross-probed.

BSTR GetCrossProbeEntityType( long nIndex )

Return Value

Returns a string that represents the internal type of the entity being cross-probed.

Paramters

nIndex – Index of the entity being cross-probed.

BSTR GetCrossProbeEntityName( long nIndex )

Return Value

Returns a string that represents the internal name of the entity being cross-probed.

void ClearCrossProbeEntities()

Marks all the entities as not used for cross-probing.

void AddCrossProbeEntity( BSTR sType, BSTR sName )

Marks an entity as used for cross-probing.

Parameters

sType – Internal type of the entity

sName – Internal name of the entity

void ZoomSelected()

Zoom fit to the selected entity / entities

void ShowNetConnectivity()

Highlight all the graphical entities

long GetNumEcadEntities(LPCTSTR sType)

Return the number of entities of a specified type that are present in the loaded document

Parameters

sType: entity type

BSTR GetEcadEntityName(LPCTSTR sType, long indx)

Return the standard name of the indexed entity of the specified type

Parameters

sType: Entity type

indx: entity index

long GetEcadEntityNAttr(LPCTSTR sType, long indx)

Return the number of attributes of the specified entity

Parameters

sType: entity type

indx: entity index

BSTR GetEcadEntityAttrName(LPCTSTR sType, long indx, long j)

Return the name of the “j”th attribute of the specified entity

Parameters

sType: entity type

indx: entity index

j: entity’s “j”th attribute

BSTR GetEcadEntityAttrValue(LPCTSTR sType, long indx, long j)

GetEcadEntityAttrName: Return the value of the “j”th attribute of the specified entity as a string

Parameters

sType: entity type

indx: entity index

j: entity’s “j”th attribute

long GetNumEcadEntityDefs()

Return the number of entity definitions

BSTR GetEcadEntityDefName(long indx)

Return the name of the indexed entity definition

Parameters

indx: entity index

long GetEcadEntityDefFlags(long indx)

Return the flags of the indexed entity definition

Parameters

indx: entity index

long GetEcadEntityDefNAttr(long indx)

Return the number of attributes of the indexed entity definition

Parameters

indx: entity index

BSTR GetEcadEntityDefAttrName(long indx, long attr)

Return the name of the “attr”th attribute of the indexed entity definition

Parameters

indx: entity index

attr: “attr” th attribute

long GetEcadEntityDefAttrFlags(long indx, long attr)

GetEcadEntityDefAttrName: Return the flags of the “attr”th attribute of the indexed entity definition

Parameters

indx: entity index

attr: “attr” th attribute

void GetEcadEntityDefAttrType(long indx, long attr)

Return the type of the “attr”th attribute of the indexed entity definition

Parameters

indx: entity index

attr: “attr” th attribute

void ShowEntityTypeFilterDlg()

Show entity type filter dialog

void ShowVerifyDesignDlg()

Show Verify Design Rule dialog

void ShowEntityBrowserDlg()

Show Entity Browser dialog.

void ShowBillOfMaterialDlg()

Show Bill of Material dialog

void ShowEntityPropertiesDlg()

Show Entity Properties Dialog

void ShowFileVersionInfoDlg()

Show File Version Information Dialog.

void SetPageByTitle(BSTR sTitle)

Set the page by Title.

Parameters

sTitle: Title of the page.

void SetNamedView(long lIndex)

Set Named views

Parameters

Llindex: Named view index

void SetNamedViewByName(BSTR sName)

Set Named view by names.

Parameters

sName: Name of the view

void ShowImportDesignDlg()

Show Import design dialog.

void EnableZoomBoxMode(boolean bEnable)

Enable zoom (box) mode.

Parameters

bEnable:

TRUE: For non-3d file format, it will force to exit from pan or magnify mode.

Enable zoom mode (zoom mode is default in non-3d file formats)

For 3d file formats it will force to enter the zoom mode

FALSE: For non-3d file format, it will not perform any action.

For 3d file formats, exit zoom mode and enter rotate mode (rotate mode is default for 3d file formats)

void EnableRotateMode(boolean bEnable)

Enable the rotate mode. Works only for 3d file format

Parameters

bEnable:

TRUE: Enter the rotate mode, will force to exit zoom, pan or spin modes.

FALSE: No action.

void ReCenter(short nType)

Applicable to 3d file formats only, re-center the complete drawing or selected entity based on “nType”

Parameters

nType:

0: Re-center the complete drawing

1: re-center the selected drawing

2: re-center the entity

void ShowPMIFilteringDlg()

Applicable to 3d file formats only. Show the PMI filter dialog.

void ShowLightingDlg()

Applicable to 3d file formats only. Show the lighting dialog.

void ShowDefineSectionDlg()

Applicable to 3d file formats only. Show the Define section dialog

void ShowUserCoordSystemsDlg()

Applicable to 3d file formats only. Show the User coordinate systems dialog

void EnableManipulators(boolean bEnable)

Applicable to 3d file formats only. Enable/Disable the manipulator

Parameters

bEnable:

TRUE: Enable the manipulator. (if already active, then no action).

FALSE: Disable the manipulator. (if already disabled ,then no action).

void ShowPartAlignmentDlg()

Applicable to 3d file formats only. Show the Part alignment dialog.

void ShowModelTransformDlg()

Applicable to 3d file formats only. Show the Model transform dialog.

void ResetTransformation()

Applicable to 3d file formats only. Reset transformation.

void ShowInterferenceCheckDlg()

Applicable to 3d file formats only. Show the interference check dialog.

long SelectOverlay()

Opens a dialog that allows a file to be selected and added as an overlay.

Returns the overlay ID, if successful, or -1 if the operation was cancelled.

long AddOverlay(BSTR sFileName)

Adds sFileName as an overlay.

Returns the overlay ID, if successful, or -1 if the operation have failed.

boolean RemoveOverlay(long ID)

Removes the overlay with id = ID.

Returns "true", if successful, or "false" if the operation have failed.

long RemoveOverlays()

Removes all existing overlays.

long LoadOverlay(BSTR sFileName, double x, double y, double scale, boolean positionByUser, boolean sizeByUser)

Adds sFileName as an overlay using the supplied parameters.

Returns the overlay ID, if successful, or -1 if the operation have failed.

Parameters:

x,y: the coordinates of the top-left corner of this new overlay

scale: the scale of this new overlay

positionByUser: if "true" the user will interactively specify the top-left corner of this overlay (position the overlay)

sizeByUser: if "true" the user will interactively specify the scale for this overlay (resize the overlay)

boolean SetOverlayParameters(int ID, double x, double y, double scale, boolean positionByUser, boolean sizeByUser)

Sets overlay parameters for the specified overlay ID. For parameters description see "LoadOverlay".

BSTR GetOverlayFileName(int ID)

Returns the filename of the overlay with specified ID.

double GetOverlayPosX(int ID)

Returns the X coordinate of the top-left corner of the overlay with specified ID.

double GetOverlayPosY(int ID)

Returns the Y coordinate of the top-left corner of the overlay with specified ID.

double GetOverlayScale(int ID)

Returns the scale of the overlay with specified ID.

BSTR GetOverlayParameters(int ID, double* x, double* y, double* scale)

Returns information about the overlay with specified ID.
File name is returned as a result from this function, top-left position and scale are set if pointers to the corresponding variables are passed.

boolean DumpModelTree( BSTR fileName)

Exports the data contained in the current model tree to the specified XML file.

Return Value
TRUE if the file could be written, FALSE otherwise.

Parameters
fileName – Output filename.

long ShowConvertDialog();

Display conversion dialog.

void ConvertIt();

Perform conversion based on the settings previously saved in avx.ini

void SetConvertOptions(string sEntry, string sValue1, string2 sValue2);

Save conversion settings into avx.ini

sEntry – option name

sValue1 – option value

sValue2 – additional option value. It is used just for PAGESIZE. Must be the empty string for all other options.

options

AREA <string>

DISPLAY | EXTENTS | ALL | SELECTED

FORMAT <string>

PCRS_BMP | PCRS_GP4 | PCRS_PCL | PCRS_PCX | PCRS_RLC | PCRS_TIF | PCVC_PDF | PCVC_PS | PC3D_STL | PC3D_VRML

SUBFORMAT <integer>

OUTPUT <filename as string>

SIZE <width as integer> <height as integer>

STEPSPERINCH <integer>

PAGESIZE <size as string>

A | B | C | D | E | A4 | A3 | A2 | A1 | A0

UNITS <unit as string>

INCH | MM

SCALE <scale as integer>%

COLORDEPTH

ORIGINAL | <number as integer>

PAGERANGE

<from_page as integer>-<to_page as integer>

STL_POSITIVE_TRIANGLES

ON | OFF

void ShowExplodeDialog()

Applicable to 3d file formats only. Show the 3D explode dialog.

void Show3DSearchDialog()

Applicable to 3d file formats only. Show the 3D search dialog.

bool Export3DBom( BSTR sFileName )

Exports the BOM data to the specified file.

Parameters

sFileName - Output filename.

Return Value

TRUE if the function succeeds, FALSE - otherwise

bool ExportEdaBom( BSTR sFileName, BSTR sFormat, boolean bCurPage, BSTR sAttributes )

Exports the BOM data to the specified file.

Parameters

sFileName - Output filename.

sFormat - Specifies the file format. Could be either "CVS" or "PDX". If nothing is specified "CVS" will be used.

bCurPage - Whether should export the BOM for the current page or all pages.

sAttributes - BOM attributes to export. If nothing is specified, the default attributes will be used.

Return Value

TRUE if the function succeeds, FALSE - otherwise

bool SaveViewStateToFile ( BSTR sFileName )

Save the current view state into an external file.

Parameters

sFileName - Output filename.

Return Value

TRUE if the function succeeds, FALSE - otherwise

bool RestoreViewStateFromFile ( BSTR sFileName )

Restore the view state from an external file and apply it.

Parameters

sFileName – Input filename.

Return Value

TRUE if the function succeeds, FALSE - otherwise

long GetNumPages ()

Obtain number of pages for the currently opened file.

Return Value

Number of pages

BSTR GetEcadDesignName ( int nPage )

Obtain design name of a page in the EDA document.

Parameters

nPage – ‘1’ based page index.

Return Value

Name of the design of the given page

BSTR GetEcadDesignPageType ( int nPage )

Obtain design page type of a page in the EDA document.

Parameters

nPage – ‘1’ based page index.

Return Value

Design type of the given page. Can be the following possible values:

· “PCB” – PCB Layout

· “SCH” – Schematic design

· “PCB3D” – PCB 3D View

BSTR GetEcadDesignPageName ( int nPage )

Obtain page name of an EDA document.

Parameters

nPage – ‘1’ based page index.

Return Value

Name of the given page

long GetNumCrossProbeHits ()

Obtain number of Crossprobe “hits” generated by the previous call to AddCrossProbeEntity.

Return Value

Number of Crossprobe “hits”.

void ShowCrossProbeHit ( long nIndex )

Instruct AutoVueX to display a Crossprobe “hit”.

Parameters

nIndex – Index of the Crossprobe “hit”. Has to be between 0 and value returned by GetNumCrossProbeHits

### Events:

void ModeChanged( short nOldMode, shortnNewMode)

Fired when mode changes

Parameters

nOldMode - OldMode Value (see GetMode method for values)

nNewMode - NewMode Value (see GetMode method for values)

void StatusChanged( short nNewStatus)

Fired when status changes

Parameter

nNewStatus - Newstatus value

STATUSIDLE = 0x00

STATUSPROCESSING= 0x01

STATUSREADING=0x02

STATUSREFRESHING= 0x04

STATUSREGENERATING= 0x08

STATUSREADINGFINISHED= 0x10

void HelpString( BSTR szMsg)

Help String for status indicator

Parameter

szMsg - help message

void ExtentsChanged( double extMinX, doubleextMinY, double extMaxX, double extMaxY )

Fired when extents change internally (not when properties change)

Parameters

extMinX, extMinY,extMaxX, extMaxY- new extents' values

void PageChanged( short nNewPage)

Fired when page changes internally

Parameter

nNewPage - new page value

void RotateChanged( short nNewRotate)

Fired when rotate value changes internally

Parameter

nNewRotate - new rotate value

void FlipChanged( short nNewFlip)

Fired when flip value changes internally

Parameter

nNewFlip - new flip value

void OnLMButtonDown( double xPos, double yPos )

Fired when left mouse button pressed down

Parameters

xPos – Horizontal Mouse Position

yPos – Vertical Mouse Position

void OnLMButtonUp( double xPos, double yPos )

Fired when left mouse button released

Parameters

xPos – Horizontal Mouse Position

yPos – Vertical Mouse Position

void OnLMButtonDblClk( double xPos, double yPos )

Fired when left mouse double-click takes place

Parameters

xPos – Horizontal Mouse Position

yPos – Vertical Mouse Position

void OnRMButtonDown( double xPos, double yPos )

Fired when right mouse button pressed down

Parameters

xPos – Horizontal Mouse Position

yPos – Vertical Mouse Position

void OnRMButtonUp( double xPos, double yPos )

Fired when right mouse button released

Parameters

xPos – Horizontal Mouse Position

yPos – Vertical Mouse Position

void OnRMButtonDblClk( double xPos, double yPos )

Fired when right mouse double-click takes place

Parameters

xPos – Horizontal Mouse Position

yPos – Vertical Mouse Position

void OnMMButtonDown( double xPos, double yPos )

Fired when middle mouse button pressed down

Parameters

xPos – Horizontal Mouse Position

yPos – Vertical Mouse Position

void OnMMButtonUp( double xPos, double yPos )

Fired when middle mouse button released

Parameters

xPos – Horizontal Mouse Position

yPos – Vertical Mouse Position

void OnMMButtonDblClk( double xPos, double yPos )

Fired when middle mouse double-click takes place

Parameters

xPos – Horizontal Mouse Position

yPos – Vertical Mouse Position

void OnMouseMove( double xPos, double yPos )

Fired when mouse gets moved

Parameters

xPos – Horizontal Mouse Position

yPos – Vertical Mouse Position

void OnNewDocument( BSTR szFileName )

Fired new file is loaded

Parameter

szFileName – New File Name

void CrossProbeEvent( short nEventType )

Fired when a crossprobe event occurred.

Parameter

nEventType – 0 , Change in entity selections

1 , Zoom selected command being invoked

2 , Show net connectivity command being invoked.

void BasefileHyperlinkEvent( short nEventType, short nArg1, BSTR szArg2 )

Fired when any of the events below occurs due to a hyperlink

Parameter

| nEventType (short) | nArg1 (short) | nArg2 (BSTR)
Set Page | 0 | Page Index | “” (not used)
Set Page by title | 1 | 0 (not used) | Title
Rotate | 2 | Degree (possible values: 0, 90, 180, 270) | “” (not used)
Flip | 3 | Flip Setting: 0 – none 1 – Horizontal flip 2 – Vertical flip 3 – Both | “” (not used)
Zoom fit | 4 | 0 (not used) | “” (not used)
Zoom by factor | 5 | Factor | “” (not used)
Set view | 6 | View index | “” (not used)
Set view by name | 7 | 0 (not used) | View name

## AvMarkupX control

### Properties:

long EntityColor

Current EntityColor (COLORREFvalue)

long PenStyle

Current Pen Style

long LineWidth

Current Line Width

### Methods:

void TestMarkup( BSTR szFileName)

Load specified file and enter markup mode

(for testing purposes)

Parameter

szFileName - file to load

void Open()

Opens Markup File

boolean OpenMarkup( BSTR sFileName, boolean bCloseAll)

Open specified markup file.

Return Value

TRUE - success

FALSE - otherwise

Parameter

szFileName - markup file name to open

bCloseAll -

True: Close all existing markup files.

False: otherwise.

boolean EnterMarkupMode( OLE_HANDLE hVcetControl)

Enter Markup Mode

Return Value

TRUE - success

FALSE - otherwise

Parameter

hVcetControl -handle of the VCET control window

long NotifyProc( long msg, long wParam, longlParam)

Called by VCET control notify procedure

Return Value

Message specific

Parameters

msg - message to process

wParam - message WPARAM

lParam - message LPARAM

void Save()

Save current markup in file

void SaveAs()

Save current markup under new name

void DrawLine()

Draw Line entity

void DrawPolyline()

Draw Polyline entity

void DrawArc()

Draw Arc entity

void DrawBox()

Draw Box entity

void DrawCircle()

Draw Circle entity

void DrawFilledBox()

Draw Filled Box entity

void DrawFilledCircle()

Draw Filled Circle entity

void DrawFilledPolygon()

Draw Filled Polygon entity

void DrawLeader()

Draw Leader entity

void DrawFreeStyle()

Draw Free Style entity

void DrawCloud()

Draw Cloud entity

void DrawText()

Draw Text entity

void DrawHighlight()

Draw Highlight entity

void DrawNote()

Draw Note entity

void DrawSymbol()

Draw Symbol entity

void DrawOle()

Draw OLE Object entity

boolean IsCurrentEntity( long nEntId, long nSubType, long nFillType)

Return Value
Returns whether the specified entity is current or not

Parameters
nEntId - The entity ID

nSubType - The sub type of the entity

nFillType - Entity Fill Type

void ModifyLayers()

Display "ModifyLayers" dialog box

void ModifyFont()

Display "ModifyFont" dialog box

void Undo()

Undo last markup operation

void Redo()

Redo last canceled markup operation

boolean IsUndoAvailable()

Return Value
Returns whether there is an operation to undo or not

boolean IsRedoAvailable()

Return Value
Returns whether there is an operation to redo or not

boolean ExitMarkupMode()

Exit Markup Mode

Return Value
TRUE - Exit successful

FALSE - User canceled operation

long GetControlHandle()

Return Value

Returns handle of the Markup control window

void MeasureDistance()

Measure distance between two points

void MeasureCumDistance()

Measure cumulative distance

void MeasureArea()

Measure area

void Calibrate()

Calibrate - currently unsupported

void ZoomFit()

Zoom to fit

void Rotate( short nDegrees)

Rotate markups

Parameters

nDegrees - rotation value, can be only 0, 90, 180,270

void Flip( short nFlag)

Flip markups

Parameters

nFlag - flipping value

0 - No flipping

1 - Flip horizontal

2 - Flip vertical

3 - Flip both

boolean ResetAction()

Reset current action

Return Value
TRUE - if action was reset from Adding Entity to None

FALSE - otherwise

void ShowInfo()

Show markup information

void CreateNew()

Open new markup

void SetFgBgColor (boolean fBackgroundColor,long color)

Parameters

fBackgroundColor – true / false

color – RGB color value

void DeleteSelEntities ()

Delete selected markup entities

boolean CopyToClipboard ()

Copy selected markup entities to clipboard

Return Value

TRUE - if action was successful

FALSE - otherwise

boolean PasteFromClipboard ()

Paste markup entities from clipboard into current active Markup / Layer

Return Value
TRUE - if action was successful

FALSE - otherwise

void OnMarkupConsolidate ()

Generate Consolidated Markup from currently loaded markups

void OnModifyMarkupOnoff ()

Toggle - Show/Hide Markups

long GetFillStyle ()

Get current fill style

Return Value
0 – No Fill

1 – Solid Fill
2 – Transparent Fill

void SetFillStyle (long nNewValue)

Set current fill style

#

# Parameters

nNewValue - 0 – No Fill / 1 – Solid Fill / 2 – Transparent Fill

long GetCtlSnapType ()

Get current snap type

Return Value

0x00000001 – MRK_SNAPTO_NONE
0x00000002 – MRK_SNAPTO_VERTEX
0x00000004 – MRK_SNAPTO_EDGE

0x00000008 – MRK_SNAPTO_MIDEDGE
0x00000010 – MRK_SNAPTO_ARCCENTER
0x00000020 – MRK_SNAPTO_FACE
combination of all above snap types – MRK_SNAPTO_ALL

void SetCtlSnapType(long dwSnapType)

Set current snap type

# Parameters

dwSnapType takes one of the following values:

0x00000001 – MRK_SNAPTO_NONE
0x00000002 – MRK_SNAPTO_VERTEX
0x00000004 – MRK_SNAPTO_EDGE
0x00000008 – MRK_SNAPTO_MIDEDGE
0x00000010 – MRK_SNAPTO_ARCCENTER
0x00000020 – MRK_SNAPTO_FACE
combination of all above snap types – MRK_SNAPTO_ALL

short GetAction ()

Get current markup control action

Return Value

0 - MRKP_ACTION_NONE
1 - MRKP_ACTION_ADD
2 - MRKP_ACTION_DEL
3 - MRKP_ACTION_COPY
4 - MRKP_ACTION_EDIT
5 - MRKP_ACTION_MOVE
6 - MRKP_ACTION_SEL
7 - MRKP_ACTION_HYBRID

void SetAction(short nAction )

Set current markup control action

# Parameters

nAction takes one of the following values:

0 - MRKP_ACTION_NONE
1 - MRKP_ACTION_ADD
2 - MRKP_ACTION_DEL
3 - MRKP_ACTION_COPY
4 - MRKP_ACTION_EDIT
5 - MRKP_ACTION_MOVE
6 - MRKP_ACTION_SEL
7 - MRKP_ACTION_HYBRID

void Draw3DVertexCoord()

Draw 3D vertex coordinate entity

void Draw3DDistance()

Draw 3D measurement distance entity

void Draw3DArc()

Draw 3D measurement arc entity

void Draw3DAngle()

Draw 3D measurement angle entity

void EditText()

Edit a text entity in the currently opened markups

void EditNote()

Edit a note entity in the currently opened markups

void EditDimension()

Edit a 3D dimension entity (including distance, arc, angle and vertex coord) in the currently opened markups

void HideDimensions()

Hide all 3D dimension entities in the currently opened markups

void DeleteDimensions()

Delete all 3D dimension entities in the currently opened markups

boolean IsThisEntityAvailable(short nEntityID )

Determine if the given entity is available

#

# Parameters

nEntityID - the entity ID

Return Value

TRUE - if this entity is available

FALSE - otherwise

boolean IsThisEntityTypeAvailable(short nEntityType )

Determine if any entity of the specified type actually exists in the currently opened markups

#

# Parameters

nEntityType - the entity type

Return Value

TRUE - if at least there is one entity of this type

FALSE - otherwise

boolean IsThisEntitySelected(short nEntityType)

Determine if any entity of the specified type is selected in the currently opened markups

#

# Parameters

nEntityType - the entity type

Return Value

TRUE - if at least one entity is selected

FALSE - otherwise

boolean IsThisEntityTypeHidden(short nEntityType)

Determine if any entity of the specified type is hidden in the currently opened markups

#

# Parameters

nEntityType - the entity type

Return Value

TRUE - if at least one entity is hidden

FALSE - otherwise

long GetEntityPageIndex(long handle)

Get the page index to which this markup entity belongs to

#

# Parameters

handle - the entity handle

Return Value

0 based page index

boolean IsEntityEditable(long handle)

Determine if the given entity is editable

#

# Parameters

handle - the entity handle

Return Value

TRUE - if the entity is editable

FALSE - otherwise

void EditEntity(long handle)

Edit the given entity

#

# Parameters

handle - the entity handle

short GetEntityLineStyle(long handle)

Get the line style of the given entity

#

# Parameters

handle - the entity handle

Return Value

0 - MRK_PENSTYLE_SOLID

1 - MRK_PENSTYLE_DASH

2 - MRK_PENSTYLE_DOT

3 - MRK_PENSTYLE_DASHDOT

4 - MRK_PENSTYLE_DASHDOTDOT

5 - MRK_PENSTYLE_HOLLOW

6 - MRK_PENSTYLE_ARC

7 - MRK_PENSTYLE_TRIANGLE

short GetEntityLineWidth(long handle)

Get the line width of the given entity

#

# Parameters

handle - the entity handle

Return Value

The line width in pixels

long GetSelCount()

Get the number of the selected entities in the currently opened markups

Return Value

the number of the selected markup entities

void RotateRelative(short nDegrees)

Rotate markup control together with base file

#

# Parameters

nDegrees - rotation angle in degree, can be only 0,90,180, 270

short IsThisMarkupVisible(long nMrkIndex)

Check if the given markup is visible

#

# Parameters

nMrkIndex - the markup index

Return Value

true if the given markup is visible, otherwise false

short ShowThisMarkup(long nMrkIndex, boolean bShow)

Show or hide the given markup

#

# Parameters

nMrkIndex - the markup index

bShow - true if show the markup, otherwise false

## AvPrintX control

### Properties:

No properties

### Methods:

void PrintIt( OLE_HANDLE hVcetControl,OLE_HANDLE hMarkupControl, boolean bPrintDirect )

Print file along with markups

Parameters

hVcetControl -handle of the VCET control window(must not be NULL)

hMarkupControl- handle of the Markup control window(can be NULL)

bPrintDirect -flag that indicates whether to show a dialog box to user or not

void PrintFile( BSTR szFileName, booleanbPrintDirect)

Print specified file

Parameters

szFileName - file name to print

bPrintDirect -flag that indicates whether to show a dialog box to user or not

void PrintPreview( OLE_HANDLE hVcetControl,OLE_HANDLE hMarkupControl, boolean bPreviewDirect, boolean bWantFrame)

Enter Print Preview mode

Parameters

hVcetControl -handle of the VCET control window(must not be NULL)

hMarkupControl- handle of the Markup control window(can be NULL)

bPreviewDirect- flag that indicates whether to showa dialog box to user or not

bWantFrame - flag for preview with frame or not

void PrintPreviewFile( BSTR szFileName, booleanbPreviewDirect, boolean bWantFrame )

Enter Print Preview mode for specified file

Parameters

szFileName - file name to preview

bPreviewDirect- flag that indicates whether to showa dialog box to user or not

bWantFrame - flag for preview with frame or not

void PreviewPrint()

In Print Preview window - send Print command

void PreviewNextPage()

In Print Preview window - go to next page

void PreviewPrevPage()

In Print Preview window - go to previous page

void PreviewNumPage()

In Print Preview window - switches between 1 and 2 page display

void PreviewZoomIn()

In Print Preview window - zoom in

void PreviewZoomOut()

In Print Preview window - zoom out

void PreviewClose()

Closes Print Preview window

void SetPrintPageOrientation( boolean bLandscape )

Set page orientation for printing

Parameters

bLandscape – true if print as landscape, otherwise as portrait

void EnablePrintOptions( short nOption, boolean bEnable )

Enable / disable a print option

Parameters

nOption takes one of the following values:

0 - PRINTOPT_GENERAL

1 - PRINTOPT_HEADERSFOOTS

2 - PRINTOPT_WATERMARK

3 - PRINTOPT_MARGINS

4 - PRINTOPT_STAMPS

5 - PRINTOPT_PENSETTINGS

6 - PRINTOPT_PRINTTOFILE

7 - PRINTOPT_PRINTSETTINGS

### Event:

void EndPrintPreview()

Fired when user closes Print Preview window

void EndPrint()

Fired when finished printing

## AutoVue CompareX Control

###

### Properties:

BSTR File1

First source file path

BSTR File2

Second source file path

boolean ShowScrollBar

Flag that indicates whether to show Scrollbar or not

boolean ShowMainToolBar

Flag that indicates whether to show Main Toolbar or not

boolean ShowAuxiToolBar

Flag that indicates whether to show Auxiliary Toolbar or not

boolean ShowStatusBar

Flag that indicates whether to show Status Bar or not

boolean EnablePopupMenu

Flag that indicates whether to enable Popup Menu or not

OLE_COLOR CtlBgColor

Background color

short Rotate

Specifies current rotation value

Can be only 0, 90, 180, 270

short Flip

0 - No flipping

1 - Flip horizontal

2 - Flip vertical

3 - Flip both

short Page

Specifies current page

short ZoomType

0 - Zoom fit width,

1 - Zoom fit height,

2 - Zoom fit both,
3- Zoom fit resolution,
4- Zoom by factor(default1)

5 - Zoom custom, following 4 properties are used to determine the extents

double ExtMinX

Minimal X coordinate of extents

double ExtMinY

Minimal Y coordinate of extents

double ExtMaxX

Maximal X coordinate of extents

double ExtMaxY

Maximal Y coordinate of extents

boolean ViewAdditions

Show the entities that are in the second file but not in the first file if true

boolean ViewDeletions

Show the entities that are in the first file but not in the second file if true

boolean ViewUnchanged

Show the entities that are in both files if true

### Methods:

void ZoomFit()

Zoom to fit

void ZoomPrevious()

Undo last zoom operation

void ZoomWidth()

Zoom to fit width

void ZoomHeight()

Zoom to fit height

void ZoomByFactor(doublefactor)

Zoom by factor

Parameters

factor - zooming factor

void ZoomFullResolution()

Displays rasters using full resolution, for other formats same as ZoomFit

void Print( boolean bDirectPrint)

Print current document

Parameters

bDirectPrint - flag that indicates whether to show a dialog box to user or not

void PrintPreview( boolean bDirectPreview)

Preview current documents

Parameters

bDirectPreview - flag that indicates whether to show a dialog box to user or not

void PageNext()

Display next page

void PagePrevious()

Display previous page

void PageSelect()

Select page number

void SetContrastLight()

Set the image contrast to be light, this only applies to raster files

void SetContrastNormal()

Set the image contrast to be normal, this only applies to raster files

void SetContrastDark()

Set the image contrast to be dark, this only applies to raster files

void SetContrastDarkest()

Set the image contrast to be the darkest, this only applies to raster files

void GetContrast()

Return the image contrast value.The value can be one of the following for the raster file
CONTRAST_LIGHT (-50)
CONTRAST_MEDIUM (0)
CONTRAST_DARK (66)
CONTRAST_DARKER (100)

void SetAntiAlias()
Scale to grey, enhances the details of the raster file image that are viewed at less than 100% zoom.
void InvertImage()
Reverses the background and foreground colors of the raster file image

void ShowLayersDlg()
Display the layer dialog

void ShowBlocksDlg()
Display the block dialog

void ShowNamedViewsDlg()
Display the named view dialog

void ShowXRefDlg()
Display the X Reference dialog

###
Event:

void StatusChanged( short nNewStatus)

Fired when status changes

Parameter

nNewStatus - New status value

STATUSIDLE = 0x00

STATUSPROCESSING = 0x01

STATUSREADING = 0x02

STATUSREFRESHING = 0x04

STATUSREGENERATING = 0x08

STATUSREADINGFINISHED = 0x10

void HelpString( BSTR szMsg)

Help String for status indicator

Parameter

szMsg - help message

void ExtentsChanged( double extMinX, doubleextMinY, double extMaxX, double extMaxY )

Fired when extents change internally (not when properties change)

Parameters

extMinX, extMinY, extMaxX, extMaxY - new extents' values

void PageChanged( short nNewPage)

Fired when page changes internally

Parameter
nNewPage - new page value

void RotateChanged( short nNewRotate)

Fired when rotate value changes internally

Parameter

nNewRotate - new rotate value

void FlipChanged( short nNewFlip)

Fired when flip value changes internally

Parameter

nNewFlip - new flip value

Copyright © 1989, 2008, Oracle and/or its affiliates. All rights reserved.

Portions of this software Copyright 1996-2007 Glyph & Cog, LLC.

Portions of this software Copyright Unisearch Ltd, Australia.

Portions of this software are owned by Siemens PLM © 1986-2008. All rights reserved.

This software uses ACIS® software by Spatial Technology Inc. ACIS® Copyright © 1994-1999 Spatial Technology Inc. All rights reserved.

Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS
Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065.

This software is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications which may create a risk of personal injury. If you use this software in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy and other measures to ensure the safe use of this software. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software in dangerous applications.

This software and documentation may provide access to or information on content, products and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third party content, products and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third party content, products or services.