Design Center v1 API - Class DisplayVariable (1.0.0-beta01)

public sealed class DisplayVariable : IMessage<DisplayVariable>, IEquatable<DisplayVariable>, IDeepCloneable<DisplayVariable>, IBufferMessage, IMessage

Reference documentation and code samples for the Design Center v1 API class DisplayVariable.

Additional display specific Template pertaining to a particular input variable.

Inheritance

object > DisplayVariable

Namespace

Google.Cloud.DesignCenter.V1

Assembly

Google.Cloud.DesignCenter.V1.dll

Constructors

DisplayVariable()

public DisplayVariable()

DisplayVariable(DisplayVariable)

public DisplayVariable(DisplayVariable other)
Parameter
Name Description
other DisplayVariable

Properties

AlternateDefaults

public RepeatedField<AlternateDefaultInput> AlternateDefaults { get; }

Optional. Alternate defaults for the input.

Property Value
Type Description
RepeatedFieldAlternateDefaultInput

EnumValueLabels

public RepeatedField<ValueLabelInput> EnumValueLabels { get; }

Optional. Labels for enum values. Values must be UTF-8 text with no markup, and at most 64 characters.

Property Value
Type Description
RepeatedFieldValueLabelInput

HasMax

public bool HasMax { get; }

Gets whether the "max" field is set

Property Value
Type Description
bool

HasMin

public bool HasMin { get; }

Gets whether the "min" field is set

Property Value
Type Description
bool

Level

public int Level { get; set; }

Optional. Indicates the "advanced" level of the input property. Level 0 (default) will always be shown. Level 1 corresponds to one expansion (user clicks "show advanced options" or "more options"). Higher levels correspond to further expansions, or they may be collapsed to level 1 by the UI implementation. Optional.

Property Value
Type Description
int

Max

public float Max { get; set; }

Optional. Maximum value for numeric types.

Property Value
Type Description
float

Min

public float Min { get; set; }

Optional. Minimum value for numeric types.

Property Value
Type Description
float

Name

public string Name { get; set; }

Required. The variable name from the corresponding standard Template file.

Property Value
Type Description
string

Properties

public MapField<string, DisplayVariable> Properties { get; }

Optional. properties is a map defining all the fields of the input variable.

Property Value
Type Description
MapFieldstringDisplayVariable

RegexValidation

public string RegexValidation { get; set; }

Optional. Regex based validation rules for the variable.

Property Value
Type Description
string

Subtext

public string Subtext { get; set; }

Optional. Property subtext, displayed below the title.

Property Value
Type Description
string

Title

public string Title { get; set; }

Required. Visible title for the variable on the UI.

Property Value
Type Description
string

Validation

public string Validation { get; set; }

Optional. Text describing the validation rules for the property. Typically shown after an invalid input. Optional. UTF-8 text. No markup. At most 128 characters.

Property Value
Type Description
string