GrapeCity.Documents.Word.BuildingBlock

Class BuildingBlock

Namespace

GrapeCity.Documents.Word

Assembly

GcDocs.Word.dll

Represents a building block in a document. A building block is pre-built content, similar to autotext, that may contain text, images, and formatting.

public class BuildingBlock

Inheritance

object

BuildingBlock

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

Body

Gets the building block content.

public Body Body { get; }

Property Value

Body

BuiltIn

Gets or sets that the name for the current building block is a built-in building block which should not be displayed in the user interface. This information can be used by an application as needed, for example, to disambiguate an building block from one with the same name, ensuring that the built-in building block can be uniquely identified by the application.

public bool BuiltIn { get; set; }

Property Value

bool

Category

Gets or sets the categorization for a building block. This categorization shall not imply any behaviors around the building block, and is only used to organize the set of building blocks within an application or user interface i.e. to disambiguate between two building blocks with the same entry name.

public Category Category { get; }

Property Value

Category

Description

Gets or sets a description for the contents of this building block. This description allows the building block to have additional information contained within the definition for this building block.

public string Description { get; set; }

Property Value

string

ID

Gets the a unique identifier that uniquely identifies this building block. This unique identifier can be used by an application to uniquely reference a single building block regardless of different naming, for example when the same part has different names for localization purposes.

public Guid ID { get; }

Property Value

System.Guid

InsertOptions

Gets or sets the set of insert options which shall be applied to the building block when it is added to the main document story. Since multiple insert options can be specified for a single building block, the sum total of all behaviors shall be used to insert the building block into the main document story.

public BuildingBlockInsertOptions InsertOptions { get; set; }

Property Value

BuildingBlockInsertOptions

Name

Gets or sets a name for the contents of this building block. This name allows the building block to have a friendly identifier contained within the definition for this building block.

public string Name { get; set; }

Property Value

string

SaveOnlySection

Gets or sets whether to save the only section properties of the building block in output.

public bool SaveOnlySection { get; set; }

Property Value

bool

Style

Gets or sets the paragraph style which shall be associated with the current building block. This paragraph style associated shall not imply anything about the formatting or content of the building block, and shall only be used to filter and/or sort this building block (via an application or a user interface). One example of the level of classification offered by this property is to only show it as available when the formatting of the paragraph matches the specified style.

public Style Style { get; set; }

Property Value

Style

Type

Gets the the set of building block types. Each of these types can, based on their values, influence the visibility and behavior of the building block.

public BuildingBlockType Type { get; set; }

Property Value

BuildingBlockType