public class BuildingBlockType
Corresponds to the ST_DocPartType type in OOXML. Example:
public void createAndInsert() throws Exception
{
// A document's glossary document stores building blocks.
Document doc = new Document();
GlossaryDocument glossaryDoc = new GlossaryDocument();
doc.setGlossaryDocument(glossaryDoc);
// Create a building block, name it, and then add it to the glossary document.
BuildingBlock block = new BuildingBlock(glossaryDoc);
block.setName("Custom Block");
glossaryDoc.appendChild(block);
// All new building block GUIDs have the same zero value by default, and we can give them a new unique value.
Assert.assertEquals(block.getGuid().toString(), "00000000-0000-0000-0000-000000000000");
block.setGuid(UUID.randomUUID());
// The following attributes categorize building blocks
// in the menu found via Insert -> Quick Parts -> Building Blocks Organizer in Microsoft Word.
Assert.assertEquals(block.getCategory(), "(Empty Category)");
Assert.assertEquals(block.getType(), BuildingBlockType.NONE);
Assert.assertEquals(block.getGallery(), BuildingBlockGallery.ALL);
Assert.assertEquals(block.getBehavior(), BuildingBlockBehavior.CONTENT);
// Before we can add this building block to our document, we will need to give it some contents.
// We will do that and set a category, gallery, and behavior with a document visitor.
BuildingBlockVisitor visitor = new BuildingBlockVisitor(glossaryDoc);
block.accept(visitor);
// We can access the block that we just made from the glossary document.
BuildingBlock customBlock = glossaryDoc.getBuildingBlock(BuildingBlockGallery.QUICK_PARTS,
"My custom building blocks", "Custom Block");
// The block itself is a section that contains the text.
Assert.assertEquals(MessageFormat.format("Text inside {0}\f", customBlock.getName()), customBlock.getFirstSection().getBody().getFirstParagraph().getText());
Assert.assertEquals(customBlock.getFirstSection(), customBlock.getLastSection());
// Now, we can insert it into the document as a new section.
doc.appendChild(doc.importNode(customBlock.getFirstSection(), true));
// We can also find it in Microsoft Word's Building Blocks Organizer and place it manually.
doc.save(getArtifactsDir() + "BuildingBlocks.CreateAndInsert.dotx");
}
/// <summary>
/// Sets up a visited building block to be inserted into the document as a quick part and adds text to its contents.
/// </summary>
public static class BuildingBlockVisitor extends DocumentVisitor {
public BuildingBlockVisitor(final GlossaryDocument ownerGlossaryDoc) {
mBuilder = new StringBuilder();
mGlossaryDoc = ownerGlossaryDoc;
}
public int visitBuildingBlockStart(final BuildingBlock block) {
// Configure the building block as a quick part, and add attributes used by Building Blocks Organizer.
block.setBehavior(BuildingBlockBehavior.PARAGRAPH);
block.setCategory("My custom building blocks");
block.setDescription("Using this block in the Quick Parts section of word will place its contents at the cursor.");
block.setGallery(BuildingBlockGallery.QUICK_PARTS);
// Add a section with text.
// Inserting the block into the document will append this section with its child nodes at the location.
Section section = new Section(mGlossaryDoc);
block.appendChild(section);
block.getFirstSection().ensureMinimum();
Run run = new Run(mGlossaryDoc, "Text inside " + block.getName());
block.getFirstSection().getBody().getFirstParagraph().appendChild(run);
return VisitorAction.CONTINUE;
}
public int visitBuildingBlockEnd(final BuildingBlock block) {
mBuilder.append("Visited " + block.getName() + "\r\n");
return VisitorAction.CONTINUE;
}
private StringBuilder mBuilder;
private GlossaryDocument mGlossaryDoc;
}
Field Summary | ||
---|---|---|
static final int | NONE | |
No type information is specified for the building block.
|
||
static final int | AUTOMATICALLY_REPLACE_NAME_WITH_CONTENT | |
Allows the building block to be automatically inserted into the document whenever
its name is entered into an application.
|
||
static final int | STRUCTURED_DOCUMENT_TAG_PLACEHOLDER_TEXT | |
The building block is a structured document tag placeholder text.
|
||
static final int | FORM_FIELD_HELP_TEXT | |
The building block is a form field help text.
|
||
static final int | NORMAL | |
The building block is a normal (i.e. regular) glossary document entry.
|
||
static final int | AUTO_CORRECT | |
The building block is associated with the spelling and grammar tools.
|
||
static final int | AUTO_TEXT | |
The building block is an AutoText entry.
|
||
static final int | ALL | |
The building block is associated with all types.
|
||
static final int | DEFAULT | |
Save as |
public static final int NONE
public static final int AUTOMATICALLY_REPLACE_NAME_WITH_CONTENT
public static final int STRUCTURED_DOCUMENT_TAG_PLACEHOLDER_TEXT
public static final int FORM_FIELD_HELP_TEXT
public static final int NORMAL
public static final int AUTO_CORRECT
public static final int AUTO_TEXT
public static final int ALL
public static final int DEFAULT