DocumentDirection

Inheritance: java.lang.Object

public class DocumentDirection

Allows to specify the direction to flow the text in a document.

Examples:

Shows how to detect plaintext document text direction.


 // Create a "TxtLoadOptions" object, which we can pass to a document's constructor
 // to modify how we load a plaintext document.
 TxtLoadOptions loadOptions = new TxtLoadOptions();

 // Set the "DocumentDirection" property to "DocumentDirection.Auto" automatically detects
 // the direction of every paragraph of text that Aspose.Words loads from plaintext.
 // Each paragraph's "Bidi" property will store its direction.
 loadOptions.setDocumentDirection(DocumentDirection.AUTO);

 // Detect Hebrew text as right-to-left.
 Document doc = new Document(getMyDir() + "Hebrew text.txt", loadOptions);

 Assert.assertTrue(doc.getFirstSection().getBody().getFirstParagraph().getParagraphFormat().getBidi());

 // Detect English text as right-to-left.
 doc = new Document(getMyDir() + "English text.txt", loadOptions);

 Assert.assertFalse(doc.getFirstSection().getBody().getFirstParagraph().getParagraphFormat().getBidi());
 

Fields

FieldDescription
AUTOAuto-detect direction.
LEFT_TO_RIGHTLeft to right direction.
RIGHT_TO_LEFTRight to left direction.
length

Methods

MethodDescription
fromName(String documentDirectionName)
getName(int documentDirection)
getValues()
toString(int documentDirection)

AUTO

public static int AUTO

Auto-detect direction.

Remarks:

When this option is selected and text contains characters belonging to RTL scripts, the document direction will be set automatically to RTL.

LEFT_TO_RIGHT

public static int LEFT_TO_RIGHT

Left to right direction.

RIGHT_TO_LEFT

public static int RIGHT_TO_LEFT

Right to left direction.

length

public static int length

fromName(String documentDirectionName)

public static int fromName(String documentDirectionName)

Parameters:

ParameterTypeDescription
documentDirectionNamejava.lang.String

Returns: int

getName(int documentDirection)

public static String getName(int documentDirection)

Parameters:

ParameterTypeDescription
documentDirectionint

Returns: java.lang.String

getValues()

public static int[] getValues()

Returns: int[]

toString(int documentDirection)

public static String toString(int documentDirection)

Parameters:

ParameterTypeDescription
documentDirectionint

Returns: java.lang.String