Aspose::Words::Settings::HyphenationOptions class
Contents
[
Hide
]HyphenationOptions class
Allows to configure document hyphenation options. To learn more, visit the Working with Hyphenation documentation article.
class HyphenationOptions : public System::Object
Methods
| Method | Description |
|---|---|
| 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() const | Gets or sets the maximum number of consecutive lines that can end with hyphens. Default value for this property is 0. |
| 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() 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). |
| GetType() const override | |
| HyphenationOptions() | |
| Is(const System::TypeInfo&) const override | |
| set_AutoHyphenation(bool) | Setter for Aspose::Words::Settings::HyphenationOptions::get_AutoHyphenation. |
| set_ConsecutiveHyphenLimit(int32_t) | Setter for Aspose::Words::Settings::HyphenationOptions::get_ConsecutiveHyphenLimit. |
| set_HyphenateCaps(bool) | Setter for Aspose::Words::Settings::HyphenationOptions::get_HyphenateCaps. |
| set_HyphenationZone(int32_t) | Setter for Aspose::Words::Settings::HyphenationOptions::get_HyphenationZone. |
| static Type() |
Examples
Shows how to configure automatic hyphenation.
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
builder->get_Font()->set_Size(24);
builder->Writeln(String(u"Lorem ipsum dolor sit amet, consectetur adipiscing elit, ") +
u"sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.");
doc->get_HyphenationOptions()->set_AutoHyphenation(true);
doc->get_HyphenationOptions()->set_ConsecutiveHyphenLimit(2);
doc->get_HyphenationOptions()->set_HyphenationZone(720);
doc->get_HyphenationOptions()->set_HyphenateCaps(true);
doc->Save(ArtifactsDir + u"Document.HyphenationOptions.docx");
See Also
- Namespace Aspose::Words::Settings
- Library Aspose.Words for C++