com.aspose.words

Class TextColumn

  • java.lang.Object
    • com.aspose.words.TextColumn
  • All Implemented Interfaces:
    java.lang.Cloneable
    public class TextColumn 
    extends java.lang.Object

Represents a single text column. TextColumn is a member of the TextColumnCollection collection. The TextColumns collection includes all the columns in a section of a document.

TextColumn objects are only used to specify columns with custom width and spacing. If you want the columns in the document to be of equal width, set TextColumns.TextColumnCollection.EvenlySpaced to true.

When a new TextColumn is created it has its width and spacing set to zero.

Example:

Shows how to create unevenly spaced columns.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
PageSetup pageSetup = builder.getPageSetup();

TextColumnCollection columns = pageSetup.getTextColumns();
columns.setEvenlySpaced(false);
columns.setCount(2);

// Determine the amount of room that we have available for arranging columns.
double contentWidth = pageSetup.getPageWidth() - pageSetup.getLeftMargin() - pageSetup.getRightMargin();

Assert.assertEquals(468.0d, contentWidth, 0.01d);

// Set the first column to be narrow.
TextColumn column = columns.get(0);
column.setWidth(100.0);
column.setSpaceAfter(20.0);

// Set the second column to take the rest of the space available within the margins of the page.
column = columns.get(1);
column.setWidth(contentWidth - column.getWidth() - column.getSpaceAfter());

builder.writeln("Narrow column 1.");
builder.insertBreak(BreakType.COLUMN_BREAK);
builder.writeln("Wide column 2.");

doc.save(getArtifactsDir() + "PageSetup.CustomColumnWidth.docx");
See Also:
TextColumnCollection, PageSetup, Section

Property Getters/Setters Summary
doublegetSpaceAfter()
void
setSpaceAfter(doublevalue)
           Gets or sets the space between this column and the next column in points. Not required for the last column.
doublegetWidth()
void
setWidth(doublevalue)
           Gets or sets the width of the text column in points.
 

    • Property Getters/Setters Detail

      • getSpaceAfter/setSpaceAfter

        public double getSpaceAfter() / public void setSpaceAfter(double value)
        
        Gets or sets the space between this column and the next column in points. Not required for the last column.

        Example:

        Shows how to create unevenly spaced columns.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        PageSetup pageSetup = builder.getPageSetup();
        
        TextColumnCollection columns = pageSetup.getTextColumns();
        columns.setEvenlySpaced(false);
        columns.setCount(2);
        
        // Determine the amount of room that we have available for arranging columns.
        double contentWidth = pageSetup.getPageWidth() - pageSetup.getLeftMargin() - pageSetup.getRightMargin();
        
        Assert.assertEquals(468.0d, contentWidth, 0.01d);
        
        // Set the first column to be narrow.
        TextColumn column = columns.get(0);
        column.setWidth(100.0);
        column.setSpaceAfter(20.0);
        
        // Set the second column to take the rest of the space available within the margins of the page.
        column = columns.get(1);
        column.setWidth(contentWidth - column.getWidth() - column.getSpaceAfter());
        
        builder.writeln("Narrow column 1.");
        builder.insertBreak(BreakType.COLUMN_BREAK);
        builder.writeln("Wide column 2.");
        
        doc.save(getArtifactsDir() + "PageSetup.CustomColumnWidth.docx");
      • getWidth/setWidth

        public double getWidth() / public void setWidth(double value)
        
        Gets or sets the width of the text column in points.

        Example:

        Shows how to create unevenly spaced columns.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        PageSetup pageSetup = builder.getPageSetup();
        
        TextColumnCollection columns = pageSetup.getTextColumns();
        columns.setEvenlySpaced(false);
        columns.setCount(2);
        
        // Determine the amount of room that we have available for arranging columns.
        double contentWidth = pageSetup.getPageWidth() - pageSetup.getLeftMargin() - pageSetup.getRightMargin();
        
        Assert.assertEquals(468.0d, contentWidth, 0.01d);
        
        // Set the first column to be narrow.
        TextColumn column = columns.get(0);
        column.setWidth(100.0);
        column.setSpaceAfter(20.0);
        
        // Set the second column to take the rest of the space available within the margins of the page.
        column = columns.get(1);
        column.setWidth(contentWidth - column.getWidth() - column.getSpaceAfter());
        
        builder.writeln("Narrow column 1.");
        builder.insertBreak(BreakType.COLUMN_BREAK);
        builder.writeln("Wide column 2.");
        
        doc.save(getArtifactsDir() + "PageSetup.CustomColumnWidth.docx");