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

Detailed Description

Allows to configure document hyphenation options.

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

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

Public Member Functions

 HyphenationOptions ()
 
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...
 
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...
 
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...
 
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_AutoHyphenation (bool value)
 Setter for get_AutoHyphenation. More...
 
void set_ConsecutiveHyphenLimit (int32_t value)
 Setter for get_ConsecutiveHyphenLimit. More...
 
void set_HyphenateCaps (bool value)
 Setter for get_HyphenateCaps. More...
 
void set_HyphenationZone (int32_t value)
 Setter for get_HyphenationZone. 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

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