Aspose::Pdf::LogicalStructure::StructureTextState Class Reference

Represents text state settings for Text Structure Elements and TaggedContent (ITextElement, ITaggedContent) More...

#include "StructureTextState.h"

Inherits System::Object.

Public Member Functions

ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Text::Fontget_Font () const
 Gets the font of text. More...
 
ASPOSE_PDF_SHARED_API void set_Font (System::SharedPtr< Aspose::Pdf::Text::Font > value)
 Sets the font of text. More...
 
ASPOSE_PDF_SHARED_API System::Nullable< float > get_FontSize () const
 Gets font size of the text. More...
 
ASPOSE_PDF_SHARED_API void set_FontSize (System::Nullable< float > value)
 Sets font size of the text. More...
 
ASPOSE_PDF_SHARED_API System::Nullable< Aspose::Pdf::Text::FontStylesget_FontStyle () const
 Gets font style of the text. More...
 
ASPOSE_PDF_SHARED_API void set_FontStyle (System::Nullable< Aspose::Pdf::Text::FontStyles > value)
 Sets font style of the text. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Colorget_ForegroundColor () const
 Gets foreground color of the text. More...
 
ASPOSE_PDF_SHARED_API void set_ForegroundColor (System::SharedPtr< Color > value)
 Sets foreground color of the text. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Colorget_BackgroundColor () const
 Gets background color of the text. More...
 
ASPOSE_PDF_SHARED_API void set_BackgroundColor (System::SharedPtr< Color > value)
 Sets background color of the text. More...
 
ASPOSE_PDF_SHARED_API System::Nullable< bool > get_Underline () const
 Gets underline for the text. More...
 
ASPOSE_PDF_SHARED_API void set_Underline (System::Nullable< bool > value)
 Sets underline for the text. More...
 
ASPOSE_PDF_SHARED_API System::Nullable< bool > get_StrikeOut () const
 Gets strikeout for the text. More...
 
ASPOSE_PDF_SHARED_API void set_StrikeOut (System::Nullable< bool > value)
 Sets strikeout for the text. More...
 
ASPOSE_PDF_SHARED_API System::Nullable< bool > get_Superscript () const
 Gets superscript of the text. More...
 
ASPOSE_PDF_SHARED_API void set_Superscript (System::Nullable< bool > value)
 Sets superscript of the text. More...
 
ASPOSE_PDF_SHARED_API System::Nullable< bool > get_Subscript () const
 Gets subscript of the text. More...
 
ASPOSE_PDF_SHARED_API void set_Subscript (System::Nullable< bool > value)
 Sets subscript of the text. More...
 
ASPOSE_PDF_SHARED_API System::Nullable< float > get_HorizontalScaling () const
 Gets horizontal scaling of the text. More...
 
ASPOSE_PDF_SHARED_API void set_HorizontalScaling (System::Nullable< float > value)
 Sets horizontal scaling of the text. More...
 
ASPOSE_PDF_SHARED_API System::Nullable< float > get_LineSpacing () const
 Gets line spacing of the text. More...
 
ASPOSE_PDF_SHARED_API void set_LineSpacing (System::Nullable< float > value)
 Sets line spacing of the text. More...
 
ASPOSE_PDF_SHARED_API System::Nullable< float > get_CharacterSpacing () const
 Gets character spacing of the text. More...
 
ASPOSE_PDF_SHARED_API void set_CharacterSpacing (System::Nullable< float > value)
 Sets character spacing of the text. More...
 
ASPOSE_PDF_SHARED_API System::Nullable< float > get_WordSpacing () const
 Gets word spacing of the text. More...
 
ASPOSE_PDF_SHARED_API void set_WordSpacing (System::Nullable< float > value)
 Sets word spacing of the text. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::MarginInfoget_MarginInfo () const
 Gets margin for block structure element. More...
 
ASPOSE_PDF_SHARED_API void set_MarginInfo (System::SharedPtr< Aspose::Pdf::MarginInfo > value)
 Sets margin for block structure element. More...
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared reference counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Protected Member Functions

 StructureTextState ()
 
 MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (StructureTextState, CODEPORTING_ARGS())
 
void InitDefault ()
 
void Update (System::SharedPtr< StructureTextState > structureTextState)
 
System::SharedPtr< Aspose::Pdf::Text::TextStateCreateTextState ()
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 

Detailed Description

Represents text state settings for Text Structure Elements and TaggedContent (ITextElement, ITaggedContent)

Constructor & Destructor Documentation

◆ StructureTextState()

Aspose::Pdf::LogicalStructure::StructureTextState::StructureTextState ( )
protected

Member Function Documentation

◆ CreateTextState()

System::SharedPtr<Aspose::Pdf::Text::TextState> Aspose::Pdf::LogicalStructure::StructureTextState::CreateTextState ( )
protected

◆ get_BackgroundColor()

ASPOSE_PDF_SHARED_API System::SharedPtr<Color> Aspose::Pdf::LogicalStructure::StructureTextState::get_BackgroundColor ( ) const

Gets background color of the text.

Can be null. Use null to inherit BackgroundColor property from parent structure element.

◆ get_CharacterSpacing()

ASPOSE_PDF_SHARED_API System::Nullable<float> Aspose::Pdf::LogicalStructure::StructureTextState::get_CharacterSpacing ( ) const

Gets character spacing of the text.

Can be null. Use null to inherit CharacterSpacing property from parent structure element.

◆ get_Font()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Text::Font> Aspose::Pdf::LogicalStructure::StructureTextState::get_Font ( ) const

Gets the font of text.

Can be null. Use null to inherit Font property from parent structure element.

◆ get_FontSize()

ASPOSE_PDF_SHARED_API System::Nullable<float> Aspose::Pdf::LogicalStructure::StructureTextState::get_FontSize ( ) const

Gets font size of the text.

Can be null. Use null to inherit FontSize property from parent structure element.

◆ get_FontStyle()

ASPOSE_PDF_SHARED_API System::Nullable<Aspose::Pdf::Text::FontStyles> Aspose::Pdf::LogicalStructure::StructureTextState::get_FontStyle ( ) const

Gets font style of the text.

Can be null. Use null to inherit FontStyle property from parent structure element.

◆ get_ForegroundColor()

ASPOSE_PDF_SHARED_API System::SharedPtr<Color> Aspose::Pdf::LogicalStructure::StructureTextState::get_ForegroundColor ( ) const

Gets foreground color of the text.

Can be null. Use null to inherit ForegroundColor property from parent structure element.

◆ get_HorizontalScaling()

ASPOSE_PDF_SHARED_API System::Nullable<float> Aspose::Pdf::LogicalStructure::StructureTextState::get_HorizontalScaling ( ) const

Gets horizontal scaling of the text.

Can be null. Use null to inherit HorizontalScaling property from parent structure element.

◆ get_LineSpacing()

ASPOSE_PDF_SHARED_API System::Nullable<float> Aspose::Pdf::LogicalStructure::StructureTextState::get_LineSpacing ( ) const

Gets line spacing of the text.

Can be null. Use null to inherit LineSpacing property from parent structure element.

◆ get_MarginInfo()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::MarginInfo> Aspose::Pdf::LogicalStructure::StructureTextState::get_MarginInfo ( ) const

Gets margin for block structure element.

◆ get_StrikeOut()

ASPOSE_PDF_SHARED_API System::Nullable<bool> Aspose::Pdf::LogicalStructure::StructureTextState::get_StrikeOut ( ) const

Gets strikeout for the text.

Can be null. Use null to inherit StrikeOut property from parent structure element.

◆ get_Subscript()

ASPOSE_PDF_SHARED_API System::Nullable<bool> Aspose::Pdf::LogicalStructure::StructureTextState::get_Subscript ( ) const

Gets subscript of the text.

Can be null. Use null to inherit Subscript property from parent structure element.

◆ get_Superscript()

ASPOSE_PDF_SHARED_API System::Nullable<bool> Aspose::Pdf::LogicalStructure::StructureTextState::get_Superscript ( ) const

Gets superscript of the text.

Can be null. Use null to inherit Superscript property from parent structure element.

◆ get_Underline()

ASPOSE_PDF_SHARED_API System::Nullable<bool> Aspose::Pdf::LogicalStructure::StructureTextState::get_Underline ( ) const

Gets underline for the text.

Can be null. Use null to inherit Underline property from parent structure element.

◆ get_WordSpacing()

ASPOSE_PDF_SHARED_API System::Nullable<float> Aspose::Pdf::LogicalStructure::StructureTextState::get_WordSpacing ( ) const

Gets word spacing of the text.

Can be null. Use null to inherit WordSpacing property from parent structure element.

◆ InitDefault()

void Aspose::Pdf::LogicalStructure::StructureTextState::InitDefault ( )
protected

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION()

Aspose::Pdf::LogicalStructure::StructureTextState::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION ( StructureTextState  ,
CODEPORTING_ARGS()   
)
protected

◆ set_BackgroundColor()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::LogicalStructure::StructureTextState::set_BackgroundColor ( System::SharedPtr< Color value)

Sets background color of the text.

Can be null. Use null to inherit BackgroundColor property from parent structure element.

◆ set_CharacterSpacing()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::LogicalStructure::StructureTextState::set_CharacterSpacing ( System::Nullable< float >  value)

Sets character spacing of the text.

Can be null. Use null to inherit CharacterSpacing property from parent structure element.

◆ set_Font()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::LogicalStructure::StructureTextState::set_Font ( System::SharedPtr< Aspose::Pdf::Text::Font value)

Sets the font of text.

Can be null. Use null to inherit Font property from parent structure element.

◆ set_FontSize()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::LogicalStructure::StructureTextState::set_FontSize ( System::Nullable< float >  value)

Sets font size of the text.

Can be null. Use null to inherit FontSize property from parent structure element.

◆ set_FontStyle()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::LogicalStructure::StructureTextState::set_FontStyle ( System::Nullable< Aspose::Pdf::Text::FontStyles value)

Sets font style of the text.

Can be null. Use null to inherit FontStyle property from parent structure element.

◆ set_ForegroundColor()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::LogicalStructure::StructureTextState::set_ForegroundColor ( System::SharedPtr< Color value)

Sets foreground color of the text.

Can be null. Use null to inherit ForegroundColor property from parent structure element.

◆ set_HorizontalScaling()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::LogicalStructure::StructureTextState::set_HorizontalScaling ( System::Nullable< float >  value)

Sets horizontal scaling of the text.

Can be null. Use null to inherit HorizontalScaling property from parent structure element.

◆ set_LineSpacing()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::LogicalStructure::StructureTextState::set_LineSpacing ( System::Nullable< float >  value)

Sets line spacing of the text.

Can be null. Use null to inherit LineSpacing property from parent structure element.

◆ set_MarginInfo()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::LogicalStructure::StructureTextState::set_MarginInfo ( System::SharedPtr< Aspose::Pdf::MarginInfo value)

Sets margin for block structure element.

◆ set_StrikeOut()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::LogicalStructure::StructureTextState::set_StrikeOut ( System::Nullable< bool >  value)

Sets strikeout for the text.

Can be null. Use null to inherit StrikeOut property from parent structure element.

◆ set_Subscript()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::LogicalStructure::StructureTextState::set_Subscript ( System::Nullable< bool >  value)

Sets subscript of the text.

Can be null. Use null to inherit Subscript property from parent structure element.

◆ set_Superscript()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::LogicalStructure::StructureTextState::set_Superscript ( System::Nullable< bool >  value)

Sets superscript of the text.

Can be null. Use null to inherit Superscript property from parent structure element.

◆ set_Underline()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::LogicalStructure::StructureTextState::set_Underline ( System::Nullable< bool >  value)

Sets underline for the text.

Can be null. Use null to inherit Underline property from parent structure element.

◆ set_WordSpacing()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::LogicalStructure::StructureTextState::set_WordSpacing ( System::Nullable< float >  value)

Sets word spacing of the text.

Can be null. Use null to inherit WordSpacing property from parent structure element.

◆ Update()

void Aspose::Pdf::LogicalStructure::StructureTextState::Update ( System::SharedPtr< StructureTextState structureTextState)
protected