AuthenticRange

www.altova.com Print this Topic Previous Page Up One Level Next page

Home >  User Reference > Objects >

AuthenticRange

See also

 

The first table lists the properties and methods of AuthenticRange that can be used to navigate through the document and select specific portions.

 

Properties

Methods

Application

Clone

MoveBegin

FirstTextPosition

CollapsToBegin

MoveEnd

FirstXMLData

CollapsToEnd

NextCursorPosition

FirstXMLDataOffset

ExpandTo

PreviousCursorPosition

LastTextPosition

Goto

Select

LastXMLData

GotoNext

SelectNext

LastXMLDataOffset

GotoPrevious

SelectPrevious

Parent

IsEmpty

SetFromRange

 

IsEqual

 

 

The following table lists the content modification methods, most of which can be found on the right/button mouse menu.

 

Properties

Edit operations

Dynamic table operations

Text

Copy

AppendRow

 

Cut

DeleteRow

 

Delete

DuplicateRow

 

Paste

InsertRow

 

 

IsInDynamicTable

 

 

MoveRowDown

 

 

MoveRowUp

 

The following methods provide the functionality of the Authentic entry helper windows for range objects.

 

 

Operations of the entry helper windows

 

Elements

 

Attributes

 

Entities

CanPerformActionWith

GetElementAttributeValue

GetEntityNames

CanPerformAction

GetElementAttributeNames

InsertEntity

PerformAction

GetElementHierarchy

 


HasElementAttribute


 

SetElementAttributeValue

 

 

Description

AuthenticRange objects are the 'cursor' selections of the automation interface. You can use them to point to any cursor position in the Authentic view, or select a portion of the document. The operations available for AuthenticRange objects then work on this selection in the same way, as the corresponding operations of the user interface do with the currrent user interface selection. The main difference is that you can use an arbitrary number of AuthenticRange objects at the same time, whereas there is exactly one cursor selection in the user interface.

 

To get to an initial range object use AuthenticView.Selection, to obtain a range corresponding with the current cursor selection in the user interface. Alternatively, some trivial ranges are accessible via the read/only properties AuthenticView.DocumentBegin, AuthenticView.DocumentEnd, and AuthenticView.WholeDocument. The most flexible method is AuthenticView.Goto, which allows navigation to a specic portion of the document within one call. For more complex selections, combine the above, with the various navigation methods on range objects listed in the first table on this page.

 

Another method to select a portion of the document is to use the position properties of the range object. Two positioning systems are available and can be combined arbitrarily:

 

Absolute text cursor positions, starting with position 0 at the document beginning, can be set and retrieved for the beginning and end of a range. For more information see FirstTextPosition and LastTextPosition. This method requires complex internal calculations and should be used with care.

 

The XMLData element and a text position inside this element, can be set and retrieved for the beginning and end of a range. For more information see FirstXMLData, FirstXMLDataOffset, LastXMLData, and LastXMLDataOffset. This method is very efficient but requires knowledge on the underlying document structure. It can be used to locate XMLData objects and perform operations on them otherwise not accessible through the user interface.

 

Modifications to the document content can be achieved by various methods:

 

The Text property allows you to retrieve the document text selected by the range object. If set, the selected document text gets replaced with the new text.
The standard document edit functions Cut, Copy, Paste and Delete.
Table operations for tables that can grow dynamically.
Methods that map the functionality of the Authentic entry helper windows.
Access to the XMLData objects of the underlying document to modify them directly.

 


© 2019 Altova GmbH