Aspose::Words::Settings::ViewOptions Class Reference

Detailed Description

Provides various options that control how a document is shown in Microsoft Word.

See also
Aspose::Words::Document, Aspose::Words::Document::get_ViewOptions

#include <Aspose.Words.Cpp/Model/Settings/ViewOptions.h>

+ Inheritance diagram for Aspose::Words::Settings::ViewOptions:

Public Member Functions

bool get_DisplayBackgroundShape () const
 Controls display of the background shape in print layout view. More...
 
bool get_DoNotDisplayPageBoundaries () const
 Turns off display of the space between the top of the text and the top edge of the page. More...
 
bool get_FormsDesign () const
 Specifies whether the document is in forms design mode. More...
 
ViewType get_ViewType () const
 Controls the view mode in Microsoft Word. More...
 
int32_t get_ZoomPercent () const
 Gets or sets the percentage (between 10 and 500) at which you want to view your document. More...
 
ZoomType get_ZoomType () const
 Gets a zoom value based on the size of the window. More...
 
void set_DisplayBackgroundShape (bool value)
 Controls display of the background shape in print layout view. More...
 
void set_DoNotDisplayPageBoundaries (bool value)
 Turns off display of the space between the top of the text and the top edge of the page. More...
 
void set_FormsDesign (bool value)
 Setter for get_FormsDesign. More...
 
void set_ViewType (ViewType value)
 Setter for get_ViewType. More...
 
void set_ZoomPercent (int32_t value)
 Setter for get_ZoomPercent. More...
 
void set_ZoomType (ZoomType value)
 Sets a zoom value based on the size of the window. 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 ()
 

Member Function Documentation

◆ get_DisplayBackgroundShape()

bool Aspose::Words::Settings::ViewOptions::get_DisplayBackgroundShape ( ) const

Controls display of the background shape in print layout view.

◆ get_DoNotDisplayPageBoundaries()

bool Aspose::Words::Settings::ViewOptions::get_DoNotDisplayPageBoundaries ( ) const

Turns off display of the space between the top of the text and the top edge of the page.

◆ get_FormsDesign()

bool Aspose::Words::Settings::ViewOptions::get_FormsDesign ( ) const

Specifies whether the document is in forms design mode.

Currently works only for documents in WordML format.

◆ get_ViewType()

Aspose::Words::Settings::ViewType Aspose::Words::Settings::ViewOptions::get_ViewType ( ) const

Controls the view mode in Microsoft Word.

Although Aspose.Words is able to read and write this option, its usage is application-specific. For example MS Word 2013 does not respect the value of this option.

◆ get_ZoomPercent()

int32_t Aspose::Words::Settings::ViewOptions::get_ZoomPercent ( ) const

Gets or sets the percentage (between 10 and 500) at which you want to view your document.

If value is 0 then this property uses 100 instead, else if value is less than 10 or greater than 500 this property throws.

Although Aspose.Words is able to read and write this option, its usage is application-specific. For example MS Word 2013 does not respect the value of this option.

◆ get_ZoomType()

Aspose::Words::Settings::ZoomType Aspose::Words::Settings::ViewOptions::get_ZoomType ( ) const

Gets a zoom value based on the size of the window.

◆ set_DisplayBackgroundShape()

void Aspose::Words::Settings::ViewOptions::set_DisplayBackgroundShape ( bool  value)

Controls display of the background shape in print layout view.

◆ set_DoNotDisplayPageBoundaries()

void Aspose::Words::Settings::ViewOptions::set_DoNotDisplayPageBoundaries ( bool  value)

Turns off display of the space between the top of the text and the top edge of the page.

◆ set_FormsDesign()

void Aspose::Words::Settings::ViewOptions::set_FormsDesign ( bool  value)

◆ set_ViewType()

void Aspose::Words::Settings::ViewOptions::set_ViewType ( Aspose::Words::Settings::ViewType  value)

◆ set_ZoomPercent()

void Aspose::Words::Settings::ViewOptions::set_ZoomPercent ( int32_t  value)

◆ set_ZoomType()

void Aspose::Words::Settings::ViewOptions::set_ZoomType ( Aspose::Words::Settings::ZoomType  value)

Sets a zoom value based on the size of the window.