Aspose::Words::BuildingBlocks Namespace Reference

Classes

class  BuildingBlock
 Represents a glossary document entry such as a Building Block, AutoText or an AutoCorrect entry. More...
 
class  BuildingBlockCollection
 A collection of Aspose::Words::BuildingBlocks::BuildingBlock objects in the document. More...
 
class  GlossaryDocument
 Represents the root element for a glossary document within a Word document. A glossary document is a storage for AutoText, AutoCorrect entries and Building Blocks. More...
 

Enumerations

enum  BuildingBlockBehavior { BuildingBlockBehavior::Content, BuildingBlockBehavior::Paragraph, BuildingBlockBehavior::Page, BuildingBlockBehavior::Default = static_cast<int32_t>(Content) }
 Specifies the behavior that shall be applied to the contents of the building block when it is inserted into the main document. More...
 
enum  BuildingBlockGallery {
  BuildingBlockGallery::All, BuildingBlockGallery::AutoText, BuildingBlockGallery::Bibliography, BuildingBlockGallery::CoverPage,
  BuildingBlockGallery::CustomAutoText, BuildingBlockGallery::CustomBibliography, BuildingBlockGallery::CustomCoverPage, BuildingBlockGallery::CustomEquations,
  BuildingBlockGallery::CustomFooters, BuildingBlockGallery::CustomHeaders, BuildingBlockGallery::Custom1, BuildingBlockGallery::Custom2,
  BuildingBlockGallery::Custom3, BuildingBlockGallery::Custom4, BuildingBlockGallery::Custom5, BuildingBlockGallery::CustomPageNumber,
  BuildingBlockGallery::CustomPageNumberAtBottom, BuildingBlockGallery::CustomPageNumberAtMargin, BuildingBlockGallery::CustomPageNumberAtTop, BuildingBlockGallery::CustomQuickParts,
  BuildingBlockGallery::CustomTableOfContents, BuildingBlockGallery::CustomTables, BuildingBlockGallery::CustomTextBox, BuildingBlockGallery::CustomWatermarks,
  BuildingBlockGallery::NoGallery, BuildingBlockGallery::QuickParts, BuildingBlockGallery::Equations, BuildingBlockGallery::Footers,
  BuildingBlockGallery::Headers, BuildingBlockGallery::PageNumber, BuildingBlockGallery::PageNumberAtBottom, BuildingBlockGallery::PageNumberAtMargin,
  BuildingBlockGallery::PageNumberAtTop, BuildingBlockGallery::StructuredDocumentTagPlaceholderText, BuildingBlockGallery::TableOfContents, BuildingBlockGallery::Tables,
  BuildingBlockGallery::TextBox, BuildingBlockGallery::Watermarks, BuildingBlockGallery::Default = static_cast<int32_t>(All)
}
 Specifies the predefined gallery into which a building block is classified. More...
 
enum  BuildingBlockType {
  BuildingBlockType::None, BuildingBlockType::AutomaticallyReplaceNameWithContent, BuildingBlockType::StructuredDocumentTagPlaceholderText, BuildingBlockType::FormFieldHelpText,
  BuildingBlockType::Normal, BuildingBlockType::AutoCorrect, BuildingBlockType::AutoText, BuildingBlockType::All,
  BuildingBlockType::Default = static_cast<int32_t>(None)
}
 Specifies a building block type. The type might affect the visibility and behavior of the building block in Microsoft Word. More...
 

Detailed Description

The Aspose.Words.BuildingBlocks namespace provides classes that allow to access and use AutoText, AutoCorrect entries and Building Blocks in a document.

Enumeration Type Documentation

◆ BuildingBlockBehavior

Specifies the behavior that shall be applied to the contents of the building block when it is inserted into the main document.

Corresponds to the ST_DocPartBehavior type in OOXML.

See also
Aspose::Words::BuildingBlocks::BuildingBlock::get_Behavior
Enumerator
Content 

Specifies that the building block shall be inserted as inline content.

Paragraph 

Specifies that the building block shall be inserted into its own paragraph.

Page 

Specifies that the building block shall be added into its own page.

Default 

Same as Aspose::Words::BuildingBlocks::BuildingBlockBehavior::Content.

◆ BuildingBlockGallery

Specifies the predefined gallery into which a building block is classified.

Corresponds to the ST_DocPartGallery type in OOXML.

See also
Aspose::Words::BuildingBlocks::BuildingBlock::get_Gallery
Enumerator
All 

Specifies that this glossary document entry shall be associated with all possible gallery classification values.

AutoText 
Bibliography 
CoverPage 
CustomAutoText 
CustomBibliography 
CustomCoverPage 
CustomEquations 
CustomFooters 
CustomHeaders 
Custom1 
Custom2 
Custom3 
Custom4 
Custom5 
CustomPageNumber 
CustomPageNumberAtBottom 
CustomPageNumberAtMargin 
CustomPageNumberAtTop 
CustomQuickParts 
CustomTableOfContents 
CustomTables 
CustomTextBox 
CustomWatermarks 
NoGallery 
QuickParts 
Equations 
Footers 
Headers 
PageNumber 
PageNumberAtBottom 
PageNumberAtMargin 
PageNumberAtTop 
StructuredDocumentTagPlaceholderText 
TableOfContents 
Tables 
TextBox 
Watermarks 
Default 

Same as Aspose::Words::BuildingBlocks::BuildingBlockGallery::All.

◆ BuildingBlockType

Specifies a building block type. The type might affect the visibility and behavior of the building block in Microsoft Word.

Corresponds to the ST_DocPartType type in OOXML.

See also
Aspose::Words::BuildingBlocks::BuildingBlock::get_Type
Enumerator
None 

No type information is specified for the building block.

AutomaticallyReplaceNameWithContent 

Allows the building block to be automatically inserted into the document whenever its name is entered into an application.

StructuredDocumentTagPlaceholderText 

The building block is a structured document tag placeholder text.

FormFieldHelpText 

The building block is a form field help text.

Normal 

The building block is a normal (i.e. regular) glossary document entry.

AutoCorrect 

The building block is associated with the spelling and grammar tools.

AutoText 

The building block is an AutoText entry.

All 

The building block is associated with all types.

Default 

Save as Aspose::Words::BuildingBlocks::BuildingBlockType::None.