Accusoft.NotateXpress13.Net
NotateXpress Class Members
Properties  Methods  Events

The following tables list the members exposed by NotateXpress.

Public Constructors
 NameDescription
Public ConstructorNotateXpress ConstructorOverloaded.   
Top
Public Properties
 NameDescription
Public PropertyAllowPaintGets and sets whether annotations are painted and rendered to the display.  
Public PropertyClientWindowGets and sets which ImagXpress viewer (ImageXView object) to annotate.  
Public PropertyContainer (Inherited from System.ComponentModel.Component)
Public PropertyDebugGets and sets whether NotateXpress is in debug mode.  
Public PropertyDebugErrorLevelGets and sets the level of detail to record in the DebugLogFile.  
Public PropertyDebugLogFileGets and sets the debug log file for writting debug information.  
Public PropertyErrorLevel

Obsolete function Please use DebugErrorLevel instead.

Gets and sets the level of detail to record in the DebugLogFile.  
Public PropertyFontScalingFontScaling is an enumerated type that determines how a font is scaled relative to an image’s vertical resolution DPI.  
Public PropertyImagXpressLoadThe ImagXpressLoad property sets or returns whether annotations are loaded from a Tiff file when a Tiff file containing annotations is loaded by ImagXpress.  
Public PropertyImagXpressSaveGets or sets whether annotations are saved into a Tiff file when the ImagXpress Save method is executed.  
Public PropertyInstanceHandleGets the Instance Handle for the NotateXpress object. This is designed to be passed to the ThumbnailXpress property NotateXpressInstance to enable annotation functionality for thumbnails. Note: ThumbnailXpress is a separate control.  
Public PropertyInteractModeGets and sets whether the annotations are in interactive mode or not.  
Public PropertyLayersThe Layer class contains attributes for elements, groups and toolbars.  
Public PropertyLineScalingGets and sets how all lines are scaled relative to an image’s vertical resolution DPI.  
Public PropertyMultiLineEditGets and sets whether to use a standard Multi-line edit control to edit text.  
Public PropertyNoteIconGets and sets the icon associated with the Notetool.  
Public PropertyPageNumberGets and sets the page number.  
Public PropertyRecalibrateXdpiGets and sets the x (horizontal) coordinate value for the DPI (dots per inch).  
Public PropertyRecalibrateYdpiGets and sets the y (vertical) coordinate value for the DPI (dots per inch).  
Public PropertySite (Inherited from System.ComponentModel.Component)
Public PropertyTextToolArrowsGets and sets if arrows should be shown on the TextTool when there is more text than what can be displayed.  
Public PropertyToolbarDefaultsGets and sets access to all of the global toolbar defaults.  
Public PropertyToolTipTimeEditGets or sets the amount of time to display tooltip window in Edit mode.  
Public PropertyToolTipTimeInteractiveGets or sets the amount of time a tooltip window remains visible.  
Public PropertyUpdateGets and sets whether annotations render to the display.  
Public PropertyVersionReturns the version of the NotateXpress control at run-time.  
Top
Public Methods
 NameDescription
Public MethodAboutBoxDisplays an information dialog box describing the NotateXpress component.  
Public MethodClientDisconnectDisconnects the NotateXpress object from the client ImageXView object.  
Public MethodCreateObjRef (Inherited from System.MarshalByRefObject)
Public MethodDispose() (Inherited from System.ComponentModel.Component)
Public MethodForceAllUpdateWhen multiple ImageXView objects are pointed to the same ImageX image, ForceAllUpdate synchronizes all NotateXpress objects to the current NotateXpress' data.  
Public MethodGetImageMappingDimensionsGets the mapping width and height coordinates when NotateXpress cannot query ImagXpress for current image dimensions.  
Public MethodGetLifetimeService (Inherited from System.MarshalByRefObject)
Public MethodGetUseCursorTypeReturns a value indicating if a distinctive cursor is used for a specific type of operation (creating, moving, or selecting objects).  
Public MethodGetUseCustomCursorTypeUses custom cursors instead of built in ones.  
Public MethodInitializeLifetimeService (Inherited from System.MarshalByRefObject)
Public MethodMenuAddItemAdds a user-defined item to the Context Menu.  
Public MethodMenuChangeItemChanges the specified menu item from the specified menu.  
Public MethodMenuDeleteItemRemoves the specified item from the specified menu.  
Public MethodMenuGetEnabledReturns whether or not the specified menu displays when the right mouse button is clicked over the appropriate area.  
Public MethodMenuGetFirstItemIdGets the TopMenuId and SubMenuId of the first item in the context or toolbar menu.  
Public MethodMenuGetItemReturns the text that will be displayed for the specified topMenuID and subMenuID on the menu.  
Public MethodMenuGetItemCheckedReturns the checked attribute of the specified menu item on the specified menu.  
Public MethodMenuGetItemEnabledGets the enabled attribute of the specified menu item on the specified menu.  
Public MethodMenuGetItemVisibleReturns the visible attribute of the specified menu item on the specified menu.  
Public MethodMenuGetNextItemIdGets the subsequent menu ID on the specified level from the specified menu after calling MenuGetFirstItemId.  
Public MethodMenuSetEnabledSets whether or not the specified menu will display when the right mouse button is clicked over the appropriate area.  
Public MethodMenuSetItemCheckedSets the checked attribute of the specified menu item on the specified menu.  
Public MethodMenuSetItemEnabledSets the Enabled attribute of the specified menu item on the specified menu.  
Public MethodMenuSetItemVisibleSets the visible attribute of the specified menu item on the specified menu.  
Public MethodSetImageMappingDimensionsSets a given mapping width and height.  
Public MethodSetUseCursorTypeReturns an indicator if a distinctive cursor is used for a specific type of operation (creating, moving, or selecting objects).  
Public MethodSetUseCustomCursorTypeThis is for replacing the built in cursors that are created by turning on SetUseCursorType.  
Public MethodToString (Inherited from System.ComponentModel.Component)
Public MethodUserDataAddAdds the specified key value pair to the list.  
Public MethodUserDataDeleteDeletes an existing key value pair which matches the given key.  
Public MethodUserDataFindUser data can be added to each page in a key value pair.  
Public MethodUserDataFindFirstFinds the first key value pair in the list.  
Public MethodUserDataFindNextFinds the next key value pair in the list.  
Top
Public Events
 NameDescription
Public EventAnnotationAddedFires when an annotation has been added.  
Public EventAnnotationDeletedFires when an annotation has been deleted.  
Public EventAnnotationEndSelectedFires when no annotations are selected.  
Public EventAnnotationMovedFires when an annotation has been moved.  
Public EventAnnotationsChangedOccurs when an annotation has changed.  
Public EventAnnotationSelectedFires when an annotation has been selected.  
Public EventClickOccurs when an annotation object is clicked in Interactive Mode.  
Public EventContextMenuOccurs when an element is right clicked in edit mode, and the built in NotateXpress context menu is turned off.  
Public EventCurrentLayerChangeThe CurrentLayerChange Event is fired whenever the current layer changes.  
Public EventDisposed (Inherited from System.ComponentModel.Component)
Public EventDoubleClickOccurs when an annotation object is double clicked in Interactive Mode.  
Public EventDroppedFires when xfdf annotations that are not supported by NotateXpress are read in.  
Public EventGroupDeselectedFired when an annotation group is unselected  
Public EventGroupSelectedFired when an annotation group is selected  
Public EventItemChangedThe ItemChanged event is sent when an annotation object changes. When an object is moved or resized by the user, an AnnotationMoved is fired.  
Public EventLayerRestoredThe LayerRestored Event is fired for each layer restored during the loading of a previously saved annotation file.  
Public EventMappingInputThis event is for an advanced user who wants to change how NotateXpress does its coordinate conversions.  
Public EventMappingOutputThis event is for an advanced user who wants to change how NotateXpress does its coordinate conversions.  
Public EventMenuSelectThe MenuSelect event is fired when a user chooses any of the items on the NotateXpress context menu while over an annotation or on the toolbar.  
Public EventMouseDownOccurs when an annotation object receives a MouseDown event in Interactive Mode.  
Public EventMouseMoveOccurs when the mouse is moved over an annotation object in Interactive Mode.  
Public EventMouseUpOccurs when an annotation object receives a MouseUp event in Interactive Mode.  
Public EventRequestLayerPasswordThe RequestLayerPassword event is sent during the loading of an annotation file for all layers that were saved with a password.  
Public EventStampingThe Stamping event is sent immediately before each stamp tool use, providing an opportunity to change the stamp text of the annotation object before it is added.  
Public EventTextEditEndFired when text editing has ended. Editing is now disabled  
Public EventTextEditStartFired when The user has double-clicked a text item and editing is now enabled.  
Public EventToolbarCloseThe ToolbarClose event is fired when the toolbar is closed.  
Public EventToolbarOpenThe ToolbarOpen event is fired when the toolbar is opened.  
Public EventToolbarSelectThe ToolbarSelect event is fired when a selection changes for the current tool on the toolbar.  
Public EventUserDrawThe UserDraw event is raised for a Rectangle object during its paint when the Rectangle’s UserDraw attribute is True.  
Public EventUserGroupCreatedThe UserGroupCreated event is sent when a user creates a new group by selecting multiple objects and then pressing Ctrl-G.  
Public EventUserGroupDestroyedThe UserGroupDestroyed event is sent when a user destroys a selected group by pressing Ctrl-U.  
Top
See Also

Reference

NotateXpress Class
Accusoft.NotateXpressSdk Namespace

 

 


©2019. Accusoft Corporation. All Rights Reserved.

Send Feedback