[]
DEMOS DOCS API PRICING
FREE TRIAL
(Showing Draft Content)

HorizontalAlignment

Enum Class HorizontalAlignment

java.lang.Object
java.lang.Enum<HorizontalAlignment>
com.grapecity.documents.excel.HorizontalAlignment
All Implemented Interfaces:
Serializable, Comparable<HorizontalAlignment>, Constable
public enum HorizontalAlignment extends Enum<HorizontalAlignment>
Specifies the horizontal alignment of a cell or object.

Use this enum with APIs such as IRange.setHorizontalAlignment(HorizontalAlignment) and IStyle.setHorizontalAlignment(HorizontalAlignment) to control how text is aligned within a cell, range, or styled object. Available values support general alignment, explicit left, center, and right alignment, repeated fill text, justified text, distributed text, and centered text across multiple cells.


 IRange range = worksheet.getRange("A1:C1");
 range.setValue("Quarterly Report");
 range.setHorizontalAlignment(HorizontalAlignment.Center);

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    Center
    Spedifies that the text should be centered.
    CenterContinuous
    Specifies that the horizontal alignment is centered across multiple cells.
    Distributed
    Specifies that text should wrap and be aligned to form straight edges on the left and right, including the last line.
    Fill
    Specifies that the text will be repeated to fill the cell.
    General
    Specifies that text is left justified, numbers (including dates and times) are right justified, and logical values are centered.
    Justify
    Specifies that text should wrap and be aligned to form straight edges on the left and right, except for the last line which is left justified.
    Left
    Spedifies left justification.
    Right
    Spedifies right justification.

  • Method Summary

    Modifier and Type
    Method
    Description
    static HorizontalAlignment
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static HorizontalAlignment[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • General

      public static final HorizontalAlignment General
      Specifies that text is left justified, numbers (including dates and times) are right justified, and logical values are centered.

    • Left

      public static final HorizontalAlignment Left
      Spedifies left justification.

    • Center

      public static final HorizontalAlignment Center
      Spedifies that the text should be centered.

    • Fill

      public static final HorizontalAlignment Fill
      Specifies that the text will be repeated to fill the cell.

    • Justify

      public static final HorizontalAlignment Justify
      Specifies that text should wrap and be aligned to form straight edges on the left and right, except for the last line which is left justified.

    • CenterContinuous

      public static final HorizontalAlignment CenterContinuous
      Specifies that the horizontal alignment is centered across multiple cells. The information about how many cells to span is expressed in the sheet part, in the row of the cell in question. For each cell that is spanned in the alignment, a cell element needs to be written out, with the same style Id which references the centerContinuous alignment.

    • Distributed

      public static final HorizontalAlignment Distributed
      Specifies that text should wrap and be aligned to form straight edges on the left and right, including the last line.

  • Method Details

    • values

      public static HorizontalAlignment[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static HorizontalAlignment valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null