NotateXpress 13 for ActiveX - API Reference > Properties, Methods, and Events by Category > Modifying Existing Annotations |
When annotations are initially created by the application, the application will be using the "Element" functions. After the annotations are created by the user or the application, the application can change annotations by using the "Prg" functions. As there are many ways of changing an existing annotation, there are sub pages to this grouping to help you focus your needs.
IsValidToolAttribute | Gets if the given attribute is valid for a specific tool type. |
PrgDeleteItem | Deletes the specific element for the specific layer. |
PrgGetFirstItem | Gets the first element in an enumeration sequence of elements for the specific layer. |
PrgGetFirstSelected | Gets the first selected element in an enumeration sequence of selected elements for the specific layer. |
PrgGetGaugeLength | Gets the gauge length for a specific element. Gauge controls the size of the lines at the end of a ruler. |
PrgGetItemAttributes | Gets the complete attribute set of an existing annotation item, and applies it to a new element. |
PrgGetItemAutoSize | Gets the autosize attribute for a specific element for the specific layer. AutoSize controls how the bounding box is sized for text, buttons, stamps, and images. |
PrgGetItemBackstyle | Gets the background style for a specific element for the specific layer. |
PrgGetItemColor | Gets the color of an attribute for the specific element for the specific layer. |
PrgGetItemCount | Gets the number of annotation elements for the specified layer. |
PrgGetItemCreateTime | Gets the create time for a specific element for the specific layer. |
PrgGetItemDIB | Gets a copy of the DIB (Device Independent Bitmap) handle for a specific element for the specific layer. |
PrgGetItemFixed | Gets the fixed attribute for a specific element for the specific layer. Fixed controls if the annotation is locked to the ImagXpress control instead of the image. |
PrgGetItemFont | Gets the font for a specific element for the specific layer |
PrgGetItemGroupID | Gets the group ID for a specific element for the specific layer |
PrgGetItemHatchColor | Gets the hatch color for a specific element for the specific layer. |
PrgGetItemHatchStyle | Gets the hatch style for a specific element for the specific layer. |
PrgGetItemHighlightBack | Gets the highlight background for a specific element for the specific layer. |
PrgGetItemHighlightFill | Gets the highlight fill for a specific element for the specific layer. |
PrgGetItemLineBeginStyle | Gets the line begin style for a specific element for the specific layer. LineBeginStyle controls the ability for arrowheads and related designs on the beginning of line based tools. |
PrgGetItemLineEndStyle | Gets the line end style for a specific element for the specific layer. LineEndStyle controls the ability for arrowheads and related designs on the end of line based tools. |
PrgGetItemLocked | Gets the locked attribute for a specific element for the specific layer. Locked controls if the user can move or select the annotation. |
PrgGetItemMoveable | Gets the moveable attribute for a specific element for the specific layer. |
PrgGetItemName | Gets the name for a specific element for the specific layer. |
PrgGetItemNumPoints | Gets the number of points allocated for a specific element for the specific layer. |
PrgGetItemPenFillStyle | Gets the pen fill style for a specific element for the specific layer. |
PrgGetItemPenStyle | Gets the pen style for a specific element for the specific layer. |
PrgGetItemPenWidth | Gets the pen width for a specific element for the specific layer. |
PrgGetItemPoint | Gets the x and y coordinates of a point allocated for a specific element for the specific layer. |
PrgGetItemPointX | Gets the x coordinate of a point allocated for a specific element for the specific layer. |
PrgGetItemPointY | Gets the y coordinate of a point allocated for a specific element for the specific layer. |
PrgGetItemRect | Gets the bounding rectangle for a specific element for the specific layer. |
PrgGetItemSelected | Gets the selected attribute for a specific element for the specific layer. |
PrgGetItemShowHandles | Gets the ShowHandles attribute for a specific element for the specific layer. The handles are represented by small "grab handles" around an element. |
PrgGetItemSizeable | Gets the sizeable attribute for a specific element for the specific layer. |
PrgGetItemText | Gets the text for a specific element for the specific layer. |
PrgGetItemTextJustification | Gets the text justification for a specific element for the specific layer. |
PrgGetItemTextLocked | Gets the textlocked attribute for a specific element for the specific layer. |
PrgGetItemTextOrientation | Gets the text orientation for a specific element for the specific layer. |
PrgGetItemTMSNote | Gets the TMSNote attribute for a specific element for the specific layer. This controls how a text element is saved in the legacy ann file format. |
PrgGetItemToolTipText | Gets the tool tip text for a specific element for the specific layer. |
PrgGetItemTransparentColor | Gets the transparent color for a specific image element for the specific layer. |
PrgGetItemType | Gets the type for a specific element for the specific layer. This controls what annotation type the element will turn into such as Ruler, Rectangle, Stamp, Image, etc. |
PrgGetItemUserDraw | Gets the userdraw attribute for a specific element for the specific layer. This controls if the application wants to draw or paint the rectangle itself. |
PrgGetItemUserLong | Gets a long that the application may associate with a specific element for the specific layer. |
PrgGetItemUserString | Gets a string that the application may associate with a specific element for the specific layer. |
PrgGetItemVisible | Gets the visibility for a specific element for the specific layer. |
PrgGetItemZOrder | Gets the Z-order (bottom to top display) for a specific element for the specific layer. |
PrgGetMeasure | Gets the unit of measure being displayed for a specific ruler element for the specific layer. |
PrgGetNextItem | Gets the next element in an enumeration sequence of elements for the specific layer. |
PrgGetNextSelected | Gets the next selected element in an enumeration sequence of selected elements for the specific layer. |
PrgGetPrecision | Gets the minimum number of digits to be displayed after the decimal point for a specific ruler element for the specific layer. |
PrgGetRulerLength | Gets the length for a specific ruler element for the specific layer. |
PrgGetShowAbbr | Gets an abbreviation attribute for a specific ruler element for the specific layer. The abbreviation is a customizable string for each unit of measure. |
PrgGetShowGauge | Gets the ShowGauge attribute for a specific ruler element for the specific layer. Gauge is the perpendicular line at the end of a ruler. |
PrgGetShowLength | Gets the ShowLength attribute for a specific ruler element for the specific layer. |
PrgItemUserDataAdd | Adds user data for a specific element for the specific layer. |
PrgItemUserDataDelete | Deletes user data from a specific element for the specific layer. |
PrgItemUserDataFind | Finds user data from a specific element for the specific layer using the provided key. |
PrgItemUserDataFindFirst | Finds the first user data pair from the list of key value pairs for a specific element for the specific layer. |
PrgItemUserDataFindNext | Finds the next user data pair from the list of key value pairs for a specific element for the specific layer. |
PrgMoveItem | Moves the specified existing annotation element for the specific layer to the new coordinates. |
PrgSelectAll | Selects or deselects all annotation elements for the specific layer. |
PrgSelectItem | Sets the selected attribute for a specific element for the specific layer. |
PrgSequenceFromEntry | Gets the unique sequence number of the specified (one-based) annotation element in the specified layer. |
PrgSetGaugeLength | Sets the gauge length for a specific element. Gauge controls the size of the lines at the end of a ruler. |
PrgSetItemAutoSize | Sets the autosize attribute for a specific element for the specific layer. AutoSize controls how the bounding box is sized for text, buttons, stamps, and images. |
PrgSetItemBackstyle | Sets the background style for a specific element for the specific layer. |
PrgSetItemColor | Sets the color of an attribute for the specific element for the specific layer. |
PrgSetItemDIB | Makes a copy of the DIB (Device Independent Bitmap) handle for a specific element for the specific layer. |
PrgSetItemFixed | Sets the fixed attribute for a specific element for the specific layer. Fixed controls if the annotation is locked to the ImagXpress control instead of the image. |
PrgSetItemFont | Sets the font for a specific element for the specific layer |
PrgSetItemHatchColor | Sets the hatch color for a specific element for the specific layer. |
PrgSetItemHatchStyle | Sets the hatch style for a specific element for the specific layer. |
PrgSetItemHighlightBack | Sets the highlight fill for a specific element for the specific layer. |
PrgSetItemHighlightFill | Sets the HighlightFill attribute of the specified object. |
PrgSetItemLineBeginStyle | Sets the line begin style for a specific element for the specific layer. LineBeginStyle controls the ability for arrowheads and related designs on the beginning of line based tools. |
PrgSetItemLineEndStyle | Sets the line end style for a specific element for the specific layer. LineEndStyle controls the ability for arrowheads and related designs on the end of line based tools. |
PrgSetItemLocked | Sets the locked attribute for a specific element for the specific layer. Locked controls if the user can move or select the annotation. |
PrgSetItemMoveable | Sets the moveable attribute for a specific element for the specific layer. |
PrgSetItemName | Sets the name for a specific element for the specific layer. |
PrgSetItemPenFillStyle | Sets the pen fill style for a specific element for the specific layer. |
PrgSetItemPenStyle | Sets the pen style for a specific element for the specific layer. |
PrgSetItemPenWidth | Sets the pen width for a specific element for the specific layer. |
PrgSetItemPoint | Sets the x and y coordinates of a point allocated for a specific element for the specific layer. |
PrgSetItemPointX | Sets the x coordinate of a point allocated for a specific element for the specific layer. |
PrgSetItemPointY | Sets the y coordinate of a point allocated for a specific element for the specific layer. |
PrgSetItemRect | Sets the bounding rectangle for a specific element for the specific layer. |
PrgSetItemSelected | Sets the selected attribute for a specific element for the specific layer. |
PrgSetItemShowHandles | Sets the ShowHandles attribute for a specific element for the specific layer. The handles are represented by small "grab handles" around an element. |
PrgSetItemSizeable | Sets the sizeable attribute for a specific element for the specific layer. |
PrgSetItemText | Sets the text for a specific element for the specific layer. |
PrgSetItemTextJustification | Sets the text justification for a specific element for the specific layer. |
PrgSetItemTextLocked | Sets the textlocked attribute for a specific element for the specific layer. |
PrgSetItemTextOrientation | Sets the text orientation for a specific element for the specific layer. |
PrgSetItemTMSNote | Sets the TMSNote attribute for a specific element for the specific layer. This controls how a text element is saved in the legacy ann file format. |
PrgSetItemToolTipText | Sets the tool tip text for a specific element for the specific layer. |
PrgSetItemTransparentColor | Sets the transparent color for a specific image element for the specific layer. |
PrgSetItemUserDraw | Sets the userdraw attribute for a specific element for the specific layer. This controls if the application wants to draw or paint the rectangle itself. |
PrgSetItemUserLong | Sets a long that the application may associate with a specific element for the specific layer. |
PrgSetItemUserString | Sets a string that the application may associate with a specific element for the specific layer. |
PrgSetItemVisible | Sets the visibility for a specific element for the specific layer. |
PrgSetItemWangType | Sets specific Eastman/Wang compatible attributes for a specific to a text element for the specific layer. |
PrgSetItemZOrder | Sets the Z-order (bottom to top display) for a specific element for the specific layer. |
PrgSetMeasure | Sets the unit of measure being displayed for a specific ruler element for the specific layer. |
PrgSetPrecision | Sets the minimum number of digits to be displayed after the decimal point for a specific ruler element for the specific layer. |
PrgSetShowAbbr | Sets an abbreviation attribute for a specific ruler element for the specific layer. The abbreviation is a customizable string for each unit of measure. |
PrgSetShowGauge | Sets the ShowGauge attribute for a specific ruler element for the specific layer. Gauge is the perpendicular line at the end of a ruler. |
PrgSetShowLength | Sets the ShowLength attribute for a specific ruler element for the specific layer. |
AnnotateEvent | Raised when there is a change in annotations. This event encompasses many sub events such as adding, deleting, and changing annotations. |
ItemChanged | Raised when an annotation element changes. |
Stamping | Raised when the stamp tool is being used and just before the stamp is displayed. |