ContentControlProperties Class

Namespace:
GemBox.Document.CustomMarkups
Assembly:
GemBox.Document.dll

Represents all possible properties for a Content Control item.

public class ContentControlProperties
Public Class ContentControlProperties
Inheritance:
System.Object
ContentControlProperties

Properties

Category

Gets or sets a value that specifies the category of document parts that will be used as the filter when determining the possible choices of document parts that are displayed for insertion into the Content Control item. A document part category is a sub-classification within a given document part Gallery which can be used to further categorize the parts in a given Gallery. This property is applicable when the parent Content Control type is BuildingBlockGallery or DocPartObj.

public string Category { get; set; }
Public Property Category As String
Property Value
System.String

The value that specifies the category of document parts that shall be used as the filter.

CharacterFormat

Gets or sets the character format for the text inside a Content Control item.

public CharacterFormat CharacterFormat { get; set; }
Public Property CharacterFormat As CharacterFormat
Property Value
CharacterFormat

The character format for the text inside a Content Control item.

Checked

Gets or sets whether a Content Control item is checked. This property is applicable when the parent Content Control type is CheckBox.

public bool Checked { get; set; }
Public Property Checked As Boolean
Property Value
System.Boolean

The value indicating whether a Content Control item is checked.

CheckedSymbol

Gets a symbol that will be used if a CheckBox is checked. This property is applicable when the parent Content Control type is CheckBox.

public CheckBoxSymbol CheckedSymbol { get; }
Public ReadOnly Property CheckedSymbol As CheckBoxSymbol
Property Value
CheckBoxSymbol

The symbol that will be used if a CheckBox is checked.

Color

Gets or sets the color of a Content Control item.

public Color Color { get; set; }
Public Property Color As Color
Property Value
Color

The color of a Content Control item.

Date

Gets or sets the date value of the Content Control item. This property is applicable when the parent Content Control type is Date.

public DateTime Date { get; set; }
Public Property Date As Date
Property Value
System.DateTime

The date value of the Content Control item.

DateCalendarType

Gets or sets a value that specifies the calendar type for a Date picker Content Control. This property is applicable when the parent Content Control type is Date.

public CalendarType DateCalendarType { get; set; }
Public Property DateCalendarType As CalendarType
Property Value
CalendarType

The value that specifies the calendar type for a Date picker content control.

DateDisplayFormat

Gets or sets a value that specifies the display format for a date. This property is applicable when the parent Content Control type is Date.

public string DateDisplayFormat { get; set; }
Public Property DateDisplayFormat As String
Property Value
System.String

The value that specifies the display format for a date.

DateLocale

Gets or sets culture info that will be used to format a date. This property is applicable when the parent Content Control type is Date.

public CultureInfo DateLocale { get; set; }
Public Property DateLocale As CultureInfo
Property Value
System.Globalization.CultureInfo

The culture info that will be used to format a date.

DateStorageFormat

Gets or sets a value that specifies the date storage format. This property is applicable when the parent Content Control type is Date.

public DateStorageFormat DateStorageFormat { get; set; }
Public Property DateStorageFormat As DateStorageFormat
Property Value
DateStorageFormat

The value that specifies the date storage format.

DisplayMode

Gets or sets a value indicating how a Content Control item should be displayed in a document.

public ContentControlDisplayMode DisplayMode { get; set; }
Public Property DisplayMode As ContentControlDisplayMode
Property Value
ContentControlDisplayMode

The value indicating how a Content Control item should be displayed in a document.

Gets or sets a value that specifies the gallery of document parts that will be used as the filter when determining the possible choices of document parts that are displayed for insertion into the Content Control item. This property is applicable when the parent Content Control type is BuildingBlockGallery or DocPartObj.

public string Gallery { get; set; }
Public Property Gallery As String
Property Value
System.String

The value that specifies the gallery of document parts that shall be used as the filter.

Id

Gets or sets the ID of a Content Control item.

public int? Id { get; set; }
Public Property Id As Integer?
Property Value
System.Nullable<System.Int32>

The ID of a Content Control item.

IsShowingPlaceholderText

Gets or sets whether the content of the Content Control should be interpreted to contain placeholder text.

public bool IsShowingPlaceholderText { get; set; }
Public Property IsShowingPlaceholderText As Boolean
Property Value
System.Boolean

True if the content of the Content Control should be interpreted to contain placeholder text; false otherwise.

ListItems

Gets list items associated with the Content Control item. This property is applicable when the parent Content Control type is ComboBox or DropDownList.

public IList<ContentControlListItem> ListItems { get; }
Public ReadOnly Property ListItems As IList(Of ContentControlListItem)
Property Value
System.Collections.Generic.IList<ContentControlListItem>

The list items associated with the Content Control item.

LockAddDeleteSection

Gets or sets a value indicating whether a user is allowed to add or delete a section. This property is applicable when the parent Content Control type is RepeatingSection.

public bool LockAddDeleteSection { get; set; }
Public Property LockAddDeleteSection As Boolean
Property Value
System.Boolean

The value indicating whether a user is allowed to add or delete a section.

LockDeleting

Gets or sets a value indicating whether a Content Control item can be deleted.

public bool LockDeleting { get; set; }
Public Property LockDeleting As Boolean
Property Value
System.Boolean

The value indicating whether a Content Control item can be deleted.

LockEditing

Gets or sets a value indicating whether the content of a Content Control item can be edited.

public bool LockEditing { get; set; }
Public Property LockEditing As Boolean
Property Value
System.Boolean

The value indicating whether the content of a Content Control item can be edited.

Multiline

Gets or sets a value indicating whether this Content Control item can contain multiple lines of text. This property is applicable when the parent Content Control type is PlainText.

public bool Multiline { get; set; }
Public Property Multiline As Boolean
Property Value
System.Boolean

The value indicating whether this Content Control item can contain multiple lines of text.

PlaceholderText

Gets or sets a placeholder text which should be displayed when Content Control is empty.

public string PlaceholderText { get; set; }
Public Property PlaceholderText As String
Property Value
System.String

The placeholder text which should be displayed when Content Control is empty.

RemoveWhenEdited

Gets or sets a value indicating whether a Content Control item should be removed after it is edited.

public bool RemoveWhenEdited { get; set; }
Public Property RemoveWhenEdited As Boolean
Property Value
System.Boolean

The value indicating whether a Content Control item should be removed after it is edited.

SectionTitle

Gets or sets a section title. This property is applicable when the parent Content Control type is RepeatingSection.

public string SectionTitle { get; set; }
Public Property SectionTitle As String
Property Value
System.String

The section title.

SelectedListItem

Gets or sets the selected value of the Content Control item. This property is applicable when the parent Content Control type is ComboBox or DropDownList.

public ContentControlListItem SelectedListItem { get; set; }
Public Property SelectedListItem As ContentControlListItem
Property Value
ContentControlListItem

The selected value of the Content Control item.

Tag

Gets or sets the tag of a Content Control item.

public string Tag { get; set; }
Public Property Tag As String
Property Value
System.String

The tag of a Content Control item.

Title

Gets or sets the title of a Content Control item.

public string Title { get; set; }
Public Property Title As String
Property Value
System.String

The title of a Content Control item.

UncheckedSymbol

Gets a symbol that will be used if a CheckBox is unchecked. This property is applicable when the parent Content Control type is CheckBox.

public CheckBoxSymbol UncheckedSymbol { get; }
Public ReadOnly Property UncheckedSymbol As CheckBoxSymbol
Property Value
CheckBoxSymbol

The symbol that will be used if a CheckBox is unchecked.

Unique

Gets or sets a value that specifies that the Content Control item is being used to encapsulate a built-in document part. This property is applicable when the parent Content Control type is BuildingBlockGallery or DocPartObj.

public bool Unique { get; set; }
Public Property Unique As Boolean
Property Value
System.Boolean

The value that specifies that the Content Control item is being used to encapsulate a built-in document part.

XmlMapping

Specifies the mapping between a content control and a custom XML part or a document property.

public XmlMapping XmlMapping { get; set; }
Public Property XmlMapping As XmlMapping
Property Value
XmlMapping

The mapping between a content control and a custom XML part or a document property. Null if there is no mapping.