Characters Object Members
Visio Automation Reference |
Represents a shape's text with the text fields expanded to the number of characters they display in a drawing window.
Methods
Name | Description | |
---|---|---|
AddCustomField | Replaces the text represented by a Characters object with a custom formula field that uses universal syntax. | |
AddCustomFieldU | Replaces the text represented by a Characters object with a custom formula field that uses universal syntax. | |
AddField | Replaces the text represented by a Characters object with a new field of the category, code, and format you specify. | |
AddFieldEx | Replaces the text represented by a Charactersobject with a new field of the category, code, format, language ID, and calendar ID you specify. | |
Copy | Copies a text range to the Clipboard. | |
Cut | Deletes a text range and places it on the Clipboard. | |
Delete | Deletes an object or selection. | |
Paste | Pastes the text range on the Clipboard into an object. |
Properties
Name | Description | |
---|---|---|
Application | Read-only. Returns the instance of Microsoft Office Visio that is associated with an object. | |
Begin | Gets or sets the beginning index of a Characters object, which represents a range of text in a shape. Read/write. | |
CharCount | Returns the number of characters in an object. Read-only. | |
CharProps | Sets a character property of a Characters object to a new value. Write-only. | |
CharPropsRow | Returns the index of the row in the Character section of a ShapeSheet window that contains character formatting information for a Characters object. Read-only. | |
ContainingMasterID | Returns the ID of the Master object that contains an object. Read-only. | |
ContainingPageID | Returns the ID of the page that contains an object. Read-only | |
Document | Gets the Document object that is associated with an object. Read-only. | |
End | Returns or sets the ending index of the indicated Characters object representing a range of text in a shape. Read/write. | |
EventList | Returns the EventList collection of an object or the EventList collection that contains an Event object. Read-only. | |
FieldCategory | Returns the field category for a field represented by an object. Read-only. | |
FieldCode | Returns the field code for a field represented by an object. Read-only. | |
FieldFormat | Returns the field format for a field represented by an object. Read-only. | |
FieldFormula | Returns the formula of the custom field represented by an object. Read-only. | |
FieldFormulaU | Returns the universal-syntax formula of the custom field represented by an object. Read-only. | |
IsField | Determines whether a Characters object represents the expanded text of a single field with no additional non-field characters. Read-only. | |
ObjectType | Returns an object's type. Read-only. | |
ParaProps | Sets the paragraph property of a Characters object to a new value. Read/write. | |
ParaPropsRow | Returns the index of the row in the Paragraph section of a ShapeSheet window that contains paragraph-formatting information for a Characters object. Read-only. | |
PersistsEvents | Indicates whether an object is capable of containing persistent events in its EventList collection. Read-only. | |
RunBegin | Returns the beginning index of a type of run—a sequence of characters that share a particular attribute, such as character, paragraph, or tab formatting; or a word, paragraph, or field. Read-only. | |
RunEnd | Returns the ending index of a type of run—a sequence of characters that share a particular attribute, such as character, paragraph, or tab formatting; or a word, paragraph, or field. Read-only. | |
Shape | Returns the Shape object that owns a Cell, Characters, Row, or Section object or that is associated with a Hyperlink or OLEObject object or with the Hyperlinks collection. Read-only. | |
Stat | Returns status information for an object. Read-only. | |
TabPropsRow | Returns the index of the row in the Tabs section of the ShapeSheet that contains tab formatting information for a Characters object. Read-only. | |
Text | Returns the range of text represented by a Characters object, which may be a subset of the shape's text depending on the values of the Characters object's Begin and End properties.Read/write. |
Events
Name | Description | |
---|---|---|
TextChanged | Occurs after the text of a shape is changed in a document.. |