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

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

#include "Aspose.Words.Cpp/Model/Settings/ViewOptions.h"

Inherits System::Object.

Public Member Functions

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

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

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

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 or sets a zoom value based on the size of the window.

◆ set_DisplayBackgroundShape()

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

◆ set_DoNotDisplayPageBoundaries()

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

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