API Reference

Class

VisioShapeDataField

Namespace OfficeIMO.Visio
Assembly OfficeIMO.Visio
Modifiers sealed

Describes one reusable Shape Data row in a VisioShapeDataSchema.

Inheritance

  • Object
  • VisioShapeDataField

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Accepted by parameters

Constructors

public VisioShapeDataField(String name) #

Initializes a Shape Data schema field.

Parameters

name System.String requiredposition: 0
Shape Data row name.

Properties

public String Name { get; } #

ShapeSheet row name.

public String DefaultValue { get; set; } #

Default value used when applying the schema to missing or overwritten fields.

public String Label { get; set; } #

Label shown in the Visio Shape Data window.

public String Prompt { get; set; } #

Prompt shown as help text in the Visio Shape Data window.

public Nullable<VisioShapeDataType> Type { get; set; } #

Shape data type.

public String Format { get; set; } #

Format picture or list items, depending on the shape data type.

public String SortKey { get; set; } #

Sort key used by Visio's Shape Data window.

public Boolean Required { get; set; } #

Whether validation should require a non-empty value.

public Nullable<Boolean> Invisible { get; set; } #

Whether the data row is hidden in the Shape Data window.

public Nullable<Boolean> Verify { get; set; } #

Whether Visio asks for this value when the shape is created, copied, or duplicated.

public Nullable<Boolean> DataLinked { get; set; } #

Whether this row is linked to an external data recordset.

public String Calendar { get; set; } #

Calendar type used for date values.

public String LangId { get; set; } #

Language identifier used for the value.

public IReadOnlyList<String> AllowedValues { get; set; } #

Allowed values used by validation and list-style field formats.