fromPoints method

fromPoints(points)

A creation method that returns a new instance that represents a preferred width specified using a number of points.

fromPoints(points: number)
ParameterTypeDescription
pointsnumberThe value must be from 0 to 22 inches (22 * 72 points).

Examples

Shows how to set a preferred width for table cells.

let doc = new aw.Document();
let builder = new aw.DocumentBuilder(doc);
let table = builder.startTable();

// There are two ways of applying the "PreferredWidth" class to table cells.
// 1 -  Set an absolute preferred width based on points:
builder.insertCell();
builder.cellFormat.preferredWidth = aw.Tables.PreferredWidth.fromPoints(40);
builder.cellFormat.shading.backgroundPatternColor = "#FFFFE0";
builder.writeln(`Cell with a width of ${builder.cellFormat.preferredWidth}.`);

// 2 -  Set a relative preferred width based on percent of the table's width:
builder.insertCell();
builder.cellFormat.preferredWidth = aw.Tables.PreferredWidth.fromPercent(20);
builder.cellFormat.shading.backgroundPatternColor = "#ADD8E6";
builder.writeln(`Cell with a width of ${builder.cellFormat.preferredWidth}.`);

builder.insertCell();

// A cell with no preferred width specified will take up the rest of the available space.
builder.cellFormat.preferredWidth = aw.Tables.PreferredWidth.auto;

builder.cellFormat.shading.backgroundPatternColor = "#90EE90";
builder.writeln("Automatically sized cell.");

doc.save(base.artifactsDir + "DocumentBuilder.InsertCellsWithPreferredWidths.docx");

Shows how to use unit conversion tools while specifying a preferred width for a cell.

let doc = new aw.Document();
let builder = new aw.DocumentBuilder(doc);

let table = builder.startTable();
builder.cellFormat.preferredWidth = aw.Tables.PreferredWidth.fromPoints(aw.ConvertUtil.inchToPoint(3));
builder.insertCell();

expect(table.firstRow.firstCell.cellFormat.preferredWidth.value).toEqual(216.0);

See Also

PreferredWidth.fromPercent method