InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
ICalculatedTextResult Class Reference

#include <ICalculatedTextResult.h>

Public Types

enum  CalculatedStringContent { kContainsUnknown = 0x00, kContainsHalfWidthNumbers = 0x01, kContainsRomanLetters = 0x02, kContainsNonRoman = 0x04 }
 

Public Member Functions

 ICalculatedTextResult (const ICalculatedTextResult &copy)
 
const WideString & GetString () const
 
WideString & GetString ()
 
CalculatedStringContent GetContentFlags () const
 
CalculatedStringContent & GetContentFlags ()
 
bool16 GetMustRegen () const
 
void SetMustRegen (bool16 mustRegen)
 

Detailed Description

This class is the result of a call to ICalculatedText. It represents a resolved calculated text character (e.g. variable, footnote, etc).

@ see ICalculatedText

Member Function Documentation

CalculatedStringContent ICalculatedTextResult::GetContentFlags () const
inline

return CalculatedStringContent which indicates the contents of the string. e.g. whether or not the string is Roman

bool16 ICalculatedTextResult::GetMustRegen () const
inline

return a bool which indicates whether the line must be regenerated on each draw or not.

void ICalculatedTextResult::SetMustRegen (bool16 mustRegen)
inline

specify whether the line must be regenerated on each draw or not.