ATE::ITextRange Class Reference

A text range, the basic text unit of the Adobe Text Engine, is a set of characters that ranges from a start offset to an end offset within a story. More...

#include <IText.h>

List of all members.

Public Member Functions
	ITextRange ()
	Constructor.
	ITextRange (const ITextRange &src)
	Copy constructor.
ITextRange &	operator= (const ITextRange &rhs)
	Assignment operator.
bool	operator== (const ITextRange &rhs) const
	Comparison operator tests for equality.
bool	operator!= (const ITextRange &rhs) const
	Comparison operator tests for inequality.
	ITextRange (TextRangeRef textrange)
	Constructs this C++ object from the corresponding C object returned by an ATE suite function.
virtual	~ITextRange ()
	Destructor.
TextRangeRef	GetRef () const
	Retrieves a reference to this object.
bool	IsNull () const
	Reports whether this is a null object.
ATETextDOM::Int32	GetStart () const
	Retrieves the start offset of this text range.
void	SetStart (ATETextDOM::Int32 start)
	Sets the start offset of this text range.
ATETextDOM::Int32	GetEnd () const
	Retrieves the end offset of this text range.
void	SetEnd (ATETextDOM::Int32 end)
	Sets the end offset of this text range.
ATETextDOM::Int32	GetSize () const
	Retrieves the size of this text range.
IStory	GetStory () const
	Retrieves the story that contains this text range.
ITextRanges	GetTextSelection () const
	Retrieves the selected text within this text range.
ITextFramesIterator	GetTextFramesIterator () const
	Creates an iterator for the text frames contained in this text range.
IParagraphsIterator	GetParagraphsIterator () const
	Creates an iterator for the paragraphs contained in this text range.
IWordsIterator	GetWordsIterator () const
	Creates an iterator for the words contained in this text range.
ITextRunsIterator	GetTextRunsIterator () const
	Creates an iterator for the text runs contained in this text range.
ICharInspector	GetCharInspector () const
	Creates an inspector with which to access the character features of all characters in this text range.
IParaInspector	GetParaInspector () const
	Creates an inspector with which to access the paragraph features of all paragraphs in this text range.
ICharStyles	GetNamedCharStyles () const
	Retrieves a set of all named character styles used in this text range.
IParaStyles	GetNamedParaStyles () const
	Retrieves a set of all named paragraph styles used in this text range.
bool	SetNamedCharStyle (const ATETextDOM::Unicode *pName)
	Associates a named character style to this text range.
bool	SetNamedParaStyle (const ATETextDOM::Unicode *pName)
	Associates a named paragraph style to this text range.
void	ClearNamedCharStyle ()
	Removes the association of this text range and its character style.
void	ClearNamedParaStyle ()
	Removes the association of this text range and its paragraph style.
ICharFeatures	GetUniqueCharFeatures () const
	Retrieves the unique character features used in this text range.
IParaFeatures	GetUniqueParaFeatures () const
	Retrieves the unique paragraph features used in this text range.
bool	HasLocalCharFeatures ()
	Reports whether there any local character feature overrides for characters contained in this text range.
bool	HasLocalParaFeatures ()
	Reports whether there any local paragraph feature overrides for paragraphs contained in this text range.
ICharFeatures	GetUniqueLocalCharFeatures ()
	Retrieves the character features that have local overrides in this text range, and whose local values are the same in all text runs in the range.
IParaFeatures	GetUniqueLocalParaFeatures ()
	Retrieves the paragraph features that have local overrides in this text range, and whose local values are the same in all text runs in the range.
void	SetLocalCharFeatures (const ICharFeatures &pFeatures)
	Replaces all of the local overrides for all characters in this text range with a new set of feature values.
void	ReplaceOrAddLocalCharFeatures (const ICharFeatures &pFeatures)
	Modifies the local overrides for all characters in this text range.
void	ClearLocalCharFeatures ()
	Removes all local overrides for all characters in this text range.
void	SetLocalParaFeatures (const IParaFeatures &pFeatures)
	Replaces all of the local overrides for all paragraphs in this text range with a new set of feature values.
void	ReplaceOrAddLocalParaFeatures (const IParaFeatures &pFeatures)
	Modifies the local overrides for all paragraphs in this text range.
void	ClearLocalParaFeatures ()
	Removes all local overrides for all paragraphs in this text range.
void	SetStory (const IStory &story)
	Associates this text range with a new story.
void	SetRange (ATETextDOM::Int32 start, ATETextDOM::Int32 end)
	Sets the start and end points of this text range.
void	Collapse (CollapseDirection direction=CollapseEnd)
	Resets start or end point of this range so that it contains only one character, either the first or the last.
ATETextDOM::Int32	Move (ATETextDOM::Int32 unit)
	Moves this text range by adding or subtracting a number of characters to or from the start and end offsets.
ITextRange	Clone () const
	Creates a duplicate of this object.
void	InsertBefore (const ATETextDOM::Unicode *text, ATETextDOM::Int32 length=-1)
	Inserts text into this text range before the current start point.
void	InsertAfter (const ATETextDOM::Unicode *text, ATETextDOM::Int32 length=-1)
	Inserts text into this text range after the current end point.
void	InsertBefore (const ITextRange &anotherRange)
	Inserts text into this text range before the current start point.
void	InsertAfter (const ITextRange &anotherRange)
	Inserts text into this text range after the current end point.
ATETextDOM::Int32	GetContents (ATETextDOM::Unicode *text, ATETextDOM::Int32 maxLength) const
	Retrieves the contents of this text range as a Unicode string.
ATETextDOM::Int32	GetContents (char *text, ATETextDOM::Int32 maxLength) const
	Retrieves the contents of this text range as a C string.
bool	GetSingleGlyphInRange (ATEGlyphID *pSingleGlyph) const
	Reports whether the characters in this text range map to a single glyph, and if so, retrieves that glyph.
void	Select (bool addToSelection=false)
	Selects the text in this text range.
void	DeSelect ()
	Deselects the text in this text range.
void	ChangeCase (CaseChangeType caseChangeType)
	Changes the case of the text in this text range.
void	FitHeadlines ()
	Adjusts the tracking of the text in this range to fit on one line spanning the width of the area text object.
void	Remove ()
	Deletes all of the characters in this text range.
ASCharType	GetCharacterType () const
	Retrieves the character type of the single character in this text range.

Detailed Description

A text range, the basic text unit of the Adobe Text Engine, is a set of characters that ranges from a start offset to an end offset within a story.

Use a text range object:

To access selected text, paragraphs, words, text frames, and text runs (character sequences that share attributes) within the contained text.
To access and modify paragraph and character styles and features in the contained text.
To convert text to a Unicode or C string.
To select or deselect text programmatically.
To convert case in text.
To find a single glyph that represents a multiple characters.

Each time you manipulate the contents of a text range, a reflow operation occurs. Reflow can change the length and endpoints of any text range in the containing story, and can cause previously obtained text runs to become invalid; see ITextRunIterator. For efficiency, you can temporarily disable reflowing, then renable it after making your changes. Use IStory::SuspendReflow() and IStory::ResumeReflow(), or the IInhibitReflow class. Functions that can cause reflow are:

InsertAfter()
InsertBefore()
Remove()
SetLocalCharFeatures()
ReplaceOrAddLocalCharFeatures()
SetLocalParaFeatures()
ReplaceOrAddLocalParaFeatures()

For example, suppose you have the initial text "0123456789", and have created two ranges, Range1 from 0 to 5 whose content is "01234", and Range2 from 3 to 9 whose content is "345678". If you call Range1.insertAfter("abc") the text becomes "01234abc56789", Range1 becomes "01234abc", and Range2 becomes "34abc5678". The offsets change automatically so that the contained text in the ranges reflects the insertion.

Constructor & Destructor Documentation

ATE::ITextRange::ITextRange ( )

Constructor.

Returns:: The new object.

Referenced by Clone().

ATE::ITextRange::ITextRange ( const ITextRange & src )

Copy constructor.

Parameters:

src

The object to copy.

Returns:: The new object.

References ATE::sTextRange.

ATE::ITextRange::ITextRange ( TextRangeRef textrange ) [explicit]

Constructs this C++ object from the corresponding C object returned by an ATE suite function.

The C++ object manages reference counting.

Parameters:

textrange

The C object.

Returns:: The new C++ object.

ATE::ITextRange::~ITextRange ( ) [virtual]

Destructor.

References ATE::sTextRange.

Member Function Documentation

void ATE::ITextRange::ChangeCase ( CaseChangeType caseChangeType )

Changes the case of the text in this text range.

Parameters:

caseChangeType

The case type constant.

Returns:: Nothing.

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

void ATE::ITextRange::ClearLocalCharFeatures ( )

Removes all local overrides for all characters in this text range.

All character features are then inherited from styles associated with the character or text range, or from the Normal style.

Returns:: Nothing.

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

void ATE::ITextRange::ClearLocalParaFeatures ( )

Removes all local overrides for all paragraphs in this text range.

All paragraph features are then inherited from styles associated with the paragraph or text range, or from the Normal style.

Returns:: Nothing.

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

void ATE::ITextRange::ClearNamedCharStyle ( )

Removes the association of this text range and its character style.

Copies the feature values of the character style into local override values in the contained characters. See ICharFeatures.

Returns:: Nothing.

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

void ATE::ITextRange::ClearNamedParaStyle ( )

Removes the association of this text range and its paragraph style.

Copies the feature values of the paragraph style into local override values in the contained paragraphs. See IParaFeatures.

Returns:: Nothing.

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

ITextRange ATE::ITextRange::Clone ( ) const

Creates a duplicate of this object.

Returns:: The new object.

References ITextRange(), ATE::sTextRange, and ATE::Throw_ATE_Exception().

void ATE::ITextRange::Collapse ( CollapseDirection direction = CollapseEnd )

Resets start or end point of this range so that it contains only one character, either the first or the last.

Parameters:

direction Optional. The direction constant. Default is CollapseEnd, which sets the start offset to the end offset. Use CollapseStart to set the end offset to the start offset.

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

void ATE::ITextRange::DeSelect ( )

Deselects the text in this text range.

This can result in a discontiguous selection, if this text range is a subset of the selected text.

Returns:: Nothing.

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

void ATE::ITextRange::FitHeadlines ( )

Adjusts the tracking of the text in this range to fit on one line spanning the width of the area text object.

This is the equivalent of choosing Type > Fit Headline with the text range selected.

Returns:: Nothing.

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

ASCharType ATE::ITextRange::GetCharacterType ( ) const

Retrieves the character type of the single character in this text range.

Throws kBadParameterErr if this text range does not contain exactly one character.

Returns:: The character type constant,

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

ICharInspector ATE::ITextRange::GetCharInspector ( ) const

Creates an inspector with which to access the character features of all characters in this text range.

Returns:: The inspector object.

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

ATETextDOM::Int32 ATE::ITextRange::GetContents	(	char *	text,
		ATETextDOM::Int32	maxLength
	)			const

Retrieves the contents of this text range as a C string.

Parameters:

	text	[out] A buffer in which to return the string.
	maxLength	The number of characters in the buffer.

Returns:: The number of characters in the returned string.

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

ATETextDOM::Int32 ATE::ITextRange::GetContents	(	ATETextDOM::Unicode *	text,
		ATETextDOM::Int32	maxLength
	)			const

Retrieves the contents of this text range as a Unicode string.

Parameters:

	text	[out] A buffer in which to return the string.
	maxLength	The number of characters in the buffer.

Returns:: The number of characters in the returned string.

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

ATETextDOM::Int32 ATE::ITextRange::GetEnd ( ) const

Retrieves the end offset of this text range.

Returns:: The 0-based index of the end offset from the beginning of the containing story.

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

ICharStyles ATE::ITextRange::GetNamedCharStyles ( ) const

Retrieves a set of all named character styles used in this text range.

Returns:: The character style set object.

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

IParaStyles ATE::ITextRange::GetNamedParaStyles ( ) const

Retrieves a set of all named paragraph styles used in this text range.

Returns:: The paragraph style set object.

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

IParagraphsIterator ATE::ITextRange::GetParagraphsIterator ( ) const

Creates an iterator for the paragraphs contained in this text range.

Returns:: The iterator object.

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

IParaInspector ATE::ITextRange::GetParaInspector ( ) const

Creates an inspector with which to access the paragraph features of all paragraphs in this text range.

Returns:: The inspector object.

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

TextRangeRef ATE::ITextRange::GetRef ( ) const

Retrieves a reference to this object.

Returns:: The object reference.

Referenced by ATE::ITextRanges::Add(), ATE::IFind::FindMatch(), ATE::IFind::FindNextMatch(), ATE::ISpell::FindOneMisspelledWord(), ATE::ISpell::FindReplaceAllWord(), ATE::IStory::GetKern(), InsertAfter(), InsertBefore(), ATE::ITextFramesIterator::ITextFramesIterator(), ATE::ISpell::Replace(), ATE::IFind::ReplaceMatch(), ATE::IStory::SetKernForSelection(), ATE::ISpell::SetSearchRange(), ATE::IFind::SetSearchRange(), ATE::IParaStyles::ShowOnlyStylesReferencedIn(), and ATE::ICharStyles::ShowOnlyStylesReferencedIn().

bool ATE::ITextRange::GetSingleGlyphInRange ( ATEGlyphID * pSingleGlyph ) const

Reports whether the characters in this text range map to a single glyph, and if so, retrieves that glyph.

Parameters:

pSingleGlyph

[out] A buffer in which to return the glyph identifier, if there is one. Otherwise, the buffer is not changed.

Returns:: True if the characters in this range map to a single glyph.

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

ATETextDOM::Int32 ATE::ITextRange::GetSize ( ) const

Retrieves the size of this text range.

Returns:: The number of characters.

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

ATETextDOM::Int32 ATE::ITextRange::GetStart ( ) const

Retrieves the start offset of this text range.

Returns:: The 0-based index of the start offset from the beginning of the containing story.

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

IStory ATE::ITextRange::GetStory ( ) const

Retrieves the story that contains this text range.

Returns:: The story object.

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

ITextFramesIterator ATE::ITextRange::GetTextFramesIterator ( ) const

Creates an iterator for the text frames contained in this text range.

Returns:: The iterator object.

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

ITextRunsIterator ATE::ITextRange::GetTextRunsIterator ( ) const

Creates an iterator for the text runs contained in this text range.

Text runs are character sequences that share attributes.

Returns:: The iterator object.

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

ITextRanges ATE::ITextRange::GetTextSelection ( ) const

Retrieves the selected text within this text range.

Returns:: The text ranges object containing the selected text.

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

ICharFeatures ATE::ITextRange::GetUniqueCharFeatures ( ) const

Retrieves the unique character features used in this text range.

Unique features are those which have the same value in all text runs in the range.

Returns:: The character features object containing the unique feature values. Other features are unassigned.

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

ICharFeatures ATE::ITextRange::GetUniqueLocalCharFeatures ( )

Retrieves the character features that have local overrides in this text range, and whose local values are the same in all text runs in the range.

Returns:: The character features object containing the unique local feature values. Other features are unassigned. If all features are unassigned, either there are no local overrides, or the local overrides have no common values.

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

IParaFeatures ATE::ITextRange::GetUniqueLocalParaFeatures ( )

Retrieves the paragraph features that have local overrides in this text range, and whose local values are the same in all text runs in the range.

Returns:: The paragraph features object containing the unique local feature values. Other features are unassigned. If all features are unassigned, either there are no local overrides, or the local overrides have no common values.

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

IParaFeatures ATE::ITextRange::GetUniqueParaFeatures ( ) const

Retrieves the unique paragraph features used in this text range.

Unique features are those which have the same value in all text runs in the range.

Returns:: The paragraph features object containing the unique feature values. Other features are unassigned.

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

IWordsIterator ATE::ITextRange::GetWordsIterator ( ) const

Creates an iterator for the words contained in this text range.

Returns:: The iterator object.

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

bool ATE::ITextRange::HasLocalCharFeatures ( )

Reports whether there any local character feature overrides for characters contained in this text range.

Returns:: True if there are local overrides.

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

bool ATE::ITextRange::HasLocalParaFeatures ( )

Reports whether there any local paragraph feature overrides for paragraphs contained in this text range.

Returns:: True if there are local overrides.

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

void ATE::ITextRange::InsertAfter ( const ITextRange & anotherRange )

Inserts text into this text range after the current end point.

Triggers a reflow operation that resets the start and end points of this and any other affected ranges to include both the old and new text.

Parameters:

anotherRange

A text range object containing the text.

See also:: IStory::SuspendReflow(), IStory::ResumeReflow()

References GetRef(), ATE::sTextRange, and ATE::Throw_ATE_Exception().

void ATE::ITextRange::InsertAfter	(	const ATETextDOM::Unicode *	text,
		ATETextDOM::Int32	length = `-1`
	)

Inserts text into this text range after the current end point.

Triggers a reflow operation that resets the start and end points of this and any other affected ranges to include both the old and new text.

Parameters:

	text	A Unicode string containing the text.
	length	(Optional) The number of characters, or -1 (the default) if the string is NULL-terminated.

See also:: IStory::SuspendReflow(), IStory::ResumeReflow()

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

void ATE::ITextRange::InsertBefore ( const ITextRange & anotherRange )

Inserts text into this text range before the current start point.

Triggers a reflow operation that resets the start and end points of this and any other affected ranges to include both the old and new text.

Parameters:

anotherRange

A text range object containing the text.

See also:: IStory::SuspendReflow(), IStory::ResumeReflow()

References GetRef(), ATE::sTextRange, and ATE::Throw_ATE_Exception().

void ATE::ITextRange::InsertBefore	(	const ATETextDOM::Unicode *	text,
		ATETextDOM::Int32	length = `-1`
	)

Inserts text into this text range before the current start point.

Triggers a reflow operation that resets the start and end points of this and any other affected ranges to include both the old and new text.

Parameters:

	text	A Unicode string containing the text.
	length	(Optional) The number of characters, or -1 (the default) if the string is NULL-terminated.

See also:: IStory::SuspendReflow(), IStory::ResumeReflow()

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

bool ATE::ITextRange::IsNull ( ) const

Reports whether this is a null object.

Returns:: True if this is a null object.

References ATE::sTextRange.

ATETextDOM::Int32 ATE::ITextRange::Move ( ATETextDOM::Int32 unit )

Moves this text range by adding or subtracting a number of characters to or from the start and end offsets.

Does not move the range if the result would be out of the story bounds.

Parameters:

unit

The number of characters, positive to move the range toward the end, negative to move it toward the beginning of the story.

Returns:: The number of characters by which the range was translated, or 0 if the translation could not be made within the story bounds.

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

bool ATE::ITextRange::operator!= ( const ITextRange & rhs ) const

Comparison operator tests for inequality.

Parameters:

rhs

The object to compare to this one.

Returns:: True if the two objects are not the same.

ITextRange & ATE::ITextRange::operator= ( const ITextRange & rhs )

Assignment operator.

Parameters:

rhs

The object to assign to this one.

Returns:: A reference to this object.

References ATE::sTextRange.

bool ATE::ITextRange::operator== ( const ITextRange & rhs ) const

Comparison operator tests for equality.

Parameters:

rhs

The object to compare to this one.

Returns:: True if the two objects are the same.

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

void ATE::ITextRange::Remove ( )

Deletes all of the characters in this text range.

Triggers a reflow operation that resets the start and end points of any other affected ranges.

Returns:: Nothing.

See also:: IStory::SuspendReflow(), IStory::ResumeReflow()

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

void ATE::ITextRange::ReplaceOrAddLocalCharFeatures ( const ICharFeatures & pFeatures )

Modifies the local overrides for all characters in this text range.

All values that are assigned become local values, replacing any previous local value. Values that are unassigned leave any previous local values unchanged.

Triggers a reflow operation that can cause previously obtained text runs to become invalid; see ITextRunIterator.

Parameters:

pFeatures

The new feature set object.

Returns:: Nothing.

See also:: IStory::SuspendReflow(), IStory::ResumeReflow()

References ATE::ICharFeatures::GetRef(), ATE::sTextRange, and ATE::Throw_ATE_Exception().

void ATE::ITextRange::ReplaceOrAddLocalParaFeatures ( const IParaFeatures & pFeatures )

Modifies the local overrides for all paragraphs in this text range.

All values that are assigned become local values, replacing any previous local value. Values that are unassigned leave any previous local values unchanged.

Triggers a reflow operation that can cause previously obtained text runs to become invalid; see ITextRunIterator.

Parameters:

pFeatures

The new feature set object.

Returns:: Nothing.

See also:: IStory::SuspendReflow(), IStory::ResumeReflow()

References ATE::IParaFeatures::GetRef(), ATE::sTextRange, and ATE::Throw_ATE_Exception().

void ATE::ITextRange::Select ( bool addToSelection = false )

Selects the text in this text range.

Parameters:

addToSelection

(Optional) True to add this text to the current selection, false (the default) to clear the current selection before selecting this text.

Returns:: Nothing.

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

void ATE::ITextRange::SetEnd ( ATETextDOM::Int32 end )

Sets the end offset of this text range.

Parameters:

end

The 0-based index of the end offset from the beginning of the containing story.

Returns:: Nothing.

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

void ATE::ITextRange::SetLocalCharFeatures ( const ICharFeatures & pFeatures )

Replaces all of the local overrides for all characters in this text range with a new set of feature values.

All values that are assigned become local values, replacing any previous local value. These local values override any specified in a style associated with the character or the text range. All values that are unassigned remove any previous local values, so that those values are inherited.

Triggers a reflow operation that can cause previously obtained text runs to become invalid; see ITextRunIterator.

Parameters:

pFeatures

The new feature set object.

Returns:: Nothing.

See also:: IStory::SuspendReflow(), IStory::ResumeReflow()

References ATE::ICharFeatures::GetRef(), ATE::sTextRange, and ATE::Throw_ATE_Exception().

void ATE::ITextRange::SetLocalParaFeatures ( const IParaFeatures & pFeatures )

Replaces all of the local overrides for all paragraphs in this text range with a new set of feature values.

All values that are assigned become local values, replacing any previous local value. These local values override any specified in a style associated with the paragraph or the text range. All values that are unassigned remove any previous local values, so that those values are inherited.

Triggers a reflow operation that can cause previously obtained text runs to become invalid; see ITextRunIterator.

Parameters:

pFeatures

The new feature set object.

Returns:: Nothing.

See also:: IStory::SuspendReflow(), IStory::ResumeReflow()

References ATE::IParaFeatures::GetRef(), ATE::sTextRange, and ATE::Throw_ATE_Exception().

bool ATE::ITextRange::SetNamedCharStyle ( const ATETextDOM::Unicode * pName )

Associates a named character style to this text range.

The inherited values can be overridden by styles or features specified locally in contained text ranges or individual characters.

Parameters:

pName

The style name.

Returns:: True if the style is successfully applied, false if there is no style with the specified name.

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

bool ATE::ITextRange::SetNamedParaStyle ( const ATETextDOM::Unicode * pName )

Associates a named paragraph style to this text range.

The inherited values can be overridden by styles or features specified locally in contained text ranges or individual paragraphs.

Parameters:

pName

The style name.

Returns:: True if the style is successfully applied, false if there is no style with the specified name.

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

void ATE::ITextRange::SetRange	(	ATETextDOM::Int32	start,
		ATETextDOM::Int32	end
	)

Sets the start and end points of this text range.

Parameters:

	start	The 0-based index of the start offset from the beginning of the containing story.
	end	The 0-based index of the end offset from the beginning of the containing story.

Returns:: Nothing.

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

void ATE::ITextRange::SetStart ( ATETextDOM::Int32 start )

Sets the start offset of this text range.

Parameters:

start

The 0-based index of the start offset from the beginning of the containing story.

Returns:: Nothing.

References ATE::sTextRange, and ATE::Throw_ATE_Exception().

void ATE::ITextRange::SetStory ( const IStory & story )

Associates this text range with a new story.

Parameters:

story

The story object.

Returns:: Nothing.

References ATE::IStory::GetRef(), ATE::sTextRange, and ATE::Throw_ATE_Exception().

The documentation for this class was generated from the following files:

ATE::ITextRange Class Reference

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation