count property

BorderCollection.count property

Gets the number of borders in the collection.

get count(): number

Examples

Shows how border collections can share elements.

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

builder.writeln("Paragraph 1.");
builder.write("Paragraph 2.");

// Since we used the same border configuration while creating
// these paragraphs, their border collections share the same elements.
let firstParagraphBorders = doc.firstSection.body.firstParagraph.paragraphFormat.borders;
let secondParagraphBorders = builder.currentParagraph.paragraphFormat.borders;
expect(firstParagraphBorders.count).toEqual(6);

for (let i = 0; i < firstParagraphBorders.count; i++)
{
  expect(firstParagraphBorders.at(i).equals(secondParagraphBorders.at(i))).toEqual(true);
  expect(firstParagraphBorders.at(i).isVisible).toEqual(false);
}

for (let border of secondParagraphBorders)
  border.lineStyle = aw.LineStyle.DotDash;

// After changing the line style of the borders in just the second paragraph,
// the border collections no longer share the same elements.
for (let i = 0; i < firstParagraphBorders.count; i++)
{
  expect(firstParagraphBorders.at(i).equals(secondParagraphBorders.at(i))).toEqual(false);

  // Changing the appearance of an empty border makes it visible.
  expect(secondParagraphBorders.at(i).isVisible).toEqual(true);
}

doc.save(base.artifactsDir + "Border.SharedElements.docx");

count property

BorderCollection.count property

Examples

See Also