Aspose::Words::Settings::HyphenationOptions Class Reference

Allows to configure document hyphenation options. More...

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

Inherits System::Object.

Public Member Functions

bool get_AutoHyphenation () const
 Gets or sets value determining whether automatic hyphenation is turned on for the document. Default value for this property is false. More...
 
void set_AutoHyphenation (bool value)
 Setter for Aspose::Words::Settings::HyphenationOptions::get_AutoHyphenation. More...
 
int32_t get_ConsecutiveHyphenLimit () const
 Gets or sets the maximum number of consecutive lines that can end with hyphens. Default value for this property is 0. More...
 
void set_ConsecutiveHyphenLimit (int32_t value)
 Setter for Aspose::Words::Settings::HyphenationOptions::get_ConsecutiveHyphenLimit. More...
 
int32_t get_HyphenationZone () const
 Gets or sets the distance in 1/20 of a point from the right margin within which you do not want to hyphenate words. Default value for this property is 360 (0.25 inch). More...
 
void set_HyphenationZone (int32_t value)
 Setter for Aspose::Words::Settings::HyphenationOptions::get_HyphenationZone. More...
 
bool get_HyphenateCaps () const
 Gets or sets value determining whether words written in all capital letters are hyphenated. Default value for this property is true. More...
 
void set_HyphenateCaps (bool value)
 Setter for Aspose::Words::Settings::HyphenationOptions::get_HyphenateCaps. More...
 
 HyphenationOptions ()
 
- 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

Allows to configure document hyphenation options.

Constructor & Destructor Documentation

◆ HyphenationOptions()

Aspose::Words::Settings::HyphenationOptions::HyphenationOptions ( )

Member Function Documentation

◆ get_AutoHyphenation()

bool Aspose::Words::Settings::HyphenationOptions::get_AutoHyphenation ( ) const

Gets or sets value determining whether automatic hyphenation is turned on for the document. Default value for this property is false.

◆ get_ConsecutiveHyphenLimit()

int32_t Aspose::Words::Settings::HyphenationOptions::get_ConsecutiveHyphenLimit ( ) const

Gets or sets the maximum number of consecutive lines that can end with hyphens. Default value for this property is 0.

If value of this property is set to 0, any number of consecutive lines can end with hyphens.

The property does not have effect when saving to fixed page formats e.g. PDF.

◆ get_HyphenateCaps()

bool Aspose::Words::Settings::HyphenationOptions::get_HyphenateCaps ( ) const

Gets or sets value determining whether words written in all capital letters are hyphenated. Default value for this property is true.

◆ get_HyphenationZone()

int32_t Aspose::Words::Settings::HyphenationOptions::get_HyphenationZone ( ) const

Gets or sets the distance in 1/20 of a point from the right margin within which you do not want to hyphenate words. Default value for this property is 360 (0.25 inch).

◆ set_AutoHyphenation()

void Aspose::Words::Settings::HyphenationOptions::set_AutoHyphenation ( bool  value)

◆ set_ConsecutiveHyphenLimit()

void Aspose::Words::Settings::HyphenationOptions::set_ConsecutiveHyphenLimit ( int32_t  value)

◆ set_HyphenateCaps()

void Aspose::Words::Settings::HyphenationOptions::set_HyphenateCaps ( bool  value)

◆ set_HyphenationZone()

void Aspose::Words::Settings::HyphenationOptions::set_HyphenationZone ( int32_t  value)