Aspose::Words::Layout::LayoutOptions Class Reference

Holds the options that allow controlling the document layout process. More...

#include "Aspose.Words.Cpp/Layout/Public/LayoutOptions.h"

Inherits System::Object.

Public Member Functions

System::SharedPtr< Aspose::Words::Layout::RevisionOptionsget_RevisionOptions () const
 Gets revision options. More...
 
bool get_ShowHiddenText () const
 Gets or sets indication of whether hidden text in the document is rendered. Default is False. More...
 
void set_ShowHiddenText (bool value)
 Setter for Aspose::Words::Layout::LayoutOptions::get_ShowHiddenText. More...
 
bool get_ShowParagraphMarks () const
 Gets or sets indication of whether paragraph marks are rendered. Default is False. More...
 
void set_ShowParagraphMarks (bool value)
 Setter for Aspose::Words::Layout::LayoutOptions::get_ShowParagraphMarks. More...
 
bool get_ShowComments ()
 Gets or sets indication of whether comments are rendered. Default is True. More...
 
void set_ShowComments (bool value)
 Setter for Aspose::Words::Layout::LayoutOptions::get_ShowComments. More...
 
System::SharedPtr< Aspose::Words::Shaping::ITextShaperFactory > get_TextShaperFactory () const
 Gets or sets Aspose::Words::Shaping::ITextShaperFactory implementation used for Advanced Typography rendering features. More...
 
void set_TextShaperFactory (System::SharedPtr< Aspose::Words::Shaping::ITextShaperFactory > value)
 Setter for Aspose::Words::Layout::LayoutOptions::get_TextShaperFactory. More...
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 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 refernce counter. More...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () ASPOSE_CONST
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual void SetTemplateWeakPtr (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. 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 ()
 Impleemnts C# typeof(System.Object) construct. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Detailed Description

Holds the options that allow controlling the document layout process.

You do not create instances of this class directly. Use the Aspose::Words::Document::get_LayoutOptions property to access layout options for this document.

Note that after changing any of the options present in this class, Aspose::Words::Document::UpdatePageLayout method should be called in order for the changed options to be applied to the layout.

Member Function Documentation

◆ get_RevisionOptions()

System::SharedPtr<Aspose::Words::Layout::RevisionOptions> Aspose::Words::Layout::LayoutOptions::get_RevisionOptions ( ) const

Gets revision options.

◆ get_ShowComments()

bool Aspose::Words::Layout::LayoutOptions::get_ShowComments ( )

Gets or sets indication of whether comments are rendered. Default is True.

◆ get_ShowHiddenText()

bool Aspose::Words::Layout::LayoutOptions::get_ShowHiddenText ( ) const

Gets or sets indication of whether hidden text in the document is rendered. Default is False.

This property affects all hidden content, not just text.

◆ get_ShowParagraphMarks()

bool Aspose::Words::Layout::LayoutOptions::get_ShowParagraphMarks ( ) const

Gets or sets indication of whether paragraph marks are rendered. Default is False.

◆ get_TextShaperFactory()

System::SharedPtr<Aspose::Words::Shaping::ITextShaperFactory> Aspose::Words::Layout::LayoutOptions::get_TextShaperFactory ( ) const

Gets or sets Aspose::Words::Shaping::ITextShaperFactory implementation used for Advanced Typography rendering features.

◆ set_ShowComments()

void Aspose::Words::Layout::LayoutOptions::set_ShowComments ( bool  value)

◆ set_ShowHiddenText()

void Aspose::Words::Layout::LayoutOptions::set_ShowHiddenText ( bool  value)

◆ set_ShowParagraphMarks()

void Aspose::Words::Layout::LayoutOptions::set_ShowParagraphMarks ( bool  value)

◆ set_TextShaperFactory()

void Aspose::Words::Layout::LayoutOptions::set_TextShaperFactory ( System::SharedPtr< Aspose::Words::Shaping::ITextShaperFactory >  value)