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

Detailed Description

Holds the options that allow controlling the document layout process.

You do not create instances of this class directly. Use the LayoutOptions property to access layout options for this document.

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

#include <Aspose.Words.Cpp/Layout/Public/LayoutOptions.h>

+ Inheritance diagram for Aspose::Words::Layout::LayoutOptions:

Public Member Functions

 LayoutOptions ()
 
SharedPtr< IPageLayoutCallbackget_Callback () const
 Gets IPageLayoutCallback implementation used by page layout model. More...
 
SharedPtr< RevisionOptionsget_RevisionOptions () const
 Gets revision options. More...
 
bool get_ShowComments ()
 Gets or sets indication of whether comments are rendered. Default is True. More...
 
bool get_ShowHiddenText () const
 Gets or sets indication of whether hidden text in the document is rendered. Default is False. More...
 
bool get_ShowParagraphMarks () const
 Gets or sets indication of whether paragraph marks are rendered. Default is False. More...
 
SharedPtr< Aspose::Words::Shaping::ITextShaperFactory > get_TextShaperFactory () const
 Gets ITextShaperFactory implementation used for Advanced Typography rendering features. More...
 
void set_Callback (SharedPtr< IPageLayoutCallback > value)
 Sets IPageLayoutCallback implementation used by page layout model. More...
 
void set_ShowComments (bool value)
 Setter for get_ShowComments. More...
 
void set_ShowHiddenText (bool value)
 Setter for get_ShowHiddenText. More...
 
void set_ShowParagraphMarks (bool value)
 Setter for get_ShowParagraphMarks. More...
 
void set_TextShaperFactory (SharedPtr< Aspose::Words::Shaping::ITextShaperFactory > value)
 Sets ITextShaperFactory implementation used for Advanced Typography rendering features. More...
 
- Public Member Functions inherited from Object
ASPOSECPP_SHARED_API Object ()
 
ASPOSECPP_SHARED_API Object (Object const &x)
 
virtual ASPOSECPP_SHARED_API ~Object ()
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 
Detail::SmartPtrCounter * GetCounter ()
 
virtual ASPOSECPP_SHARED_API int GetHashCode () const
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 
ASPOSECPP_SHARED_API void Lock ()
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 
Objectoperator= (Object const &x)
 
bool ReferenceEquals (String const &str, std::nullptr_t)
 
bool ReferenceEquals (String const &str1, String const &str2)
 
int RemovedSharedRefs (int count)
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (unsigned int argument)
 
int SharedCount () const
 
ObjectSharedRefAdded ()
 
int SharedRefRemovedSafe ()
 
virtual ASPOSECPP_SHARED_API String ToString () const
 
ASPOSECPP_SHARED_API void Unlock ()
 
Detail::SmartPtrCounter * WeakRefAdded ()
 
void WeakRefRemoved ()
 

Additional Inherited Members

- Public Types inherited from Object
typedef SmartPtr< Objectptr
 
typedef System::Details::SharedMembersType shared_members_type
 
- Static Public Member Functions inherited from Object
bool Equals (double const &objA, double const &objB)
 
bool Equals (float const &objA, float const &objB)
 
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 
static const TypeInfoType ()
 

Constructor & Destructor Documentation

◆ LayoutOptions()

Aspose::Words::Layout::LayoutOptions::LayoutOptions ( )

Member Function Documentation

◆ get_Callback()

System::SharedPtr<Aspose::Words::Layout::IPageLayoutCallback> Aspose::Words::Layout::LayoutOptions::get_Callback ( ) const

Gets IPageLayoutCallback implementation used by page layout model.

◆ 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 ITextShaperFactory implementation used for Advanced Typography rendering features.

◆ set_Callback()

void Aspose::Words::Layout::LayoutOptions::set_Callback ( System::SharedPtr< Aspose::Words::Layout::IPageLayoutCallback value)

Sets IPageLayoutCallback implementation used by page layout model.

◆ 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)

Sets ITextShaperFactory implementation used for Advanced Typography rendering features.