Class CfnTemplate.ParameterListControlProperty

A control to display a list with buttons or boxes that are used to select either a single value or multiple values.

Inheritance

object

CfnTemplate.ParameterListControlProperty

Implements

CfnTemplate.IParameterListControlProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.QuickSight

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnTemplate.ParameterListControlProperty : CfnTemplate.IParameterListControlProperty

Syntax (vb)

Public Class CfnTemplate.ParameterListControlProperty Implements CfnTemplate.IParameterListControlProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterlistcontrol.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.QuickSight;

             var parameterListControlProperty = new ParameterListControlProperty {
                 ParameterControlId = "parameterControlId",
                 SourceParameterName = "sourceParameterName",
                 Title = "title",

                 // the properties below are optional
                 CascadingControlConfiguration = new CascadingControlConfigurationProperty {
                     SourceControls = new [] { new CascadingControlSourceProperty {
                         ColumnToMatch = new ColumnIdentifierProperty {
                             ColumnName = "columnName",
                             DataSetIdentifier = "dataSetIdentifier"
                         },
                         SourceSheetControlId = "sourceSheetControlId"
                     } }
                 },
                 DisplayOptions = new ListControlDisplayOptionsProperty {
                     InfoIconLabelOptions = new SheetControlInfoIconLabelOptionsProperty {
                         InfoIconText = "infoIconText",
                         Visibility = "visibility"
                     },
                     SearchOptions = new ListControlSearchOptionsProperty {
                         Visibility = "visibility"
                     },
                     SelectAllOptions = new ListControlSelectAllOptionsProperty {
                         Visibility = "visibility"
                     },
                     TitleOptions = new LabelOptionsProperty {
                         CustomLabel = "customLabel",
                         FontConfiguration = new FontConfigurationProperty {
                             FontColor = "fontColor",
                             FontDecoration = "fontDecoration",
                             FontFamily = "fontFamily",
                             FontSize = new FontSizeProperty {
                                 Absolute = "absolute",
                                 Relative = "relative"
                             },
                             FontStyle = "fontStyle",
                             FontWeight = new FontWeightProperty {
                                 Name = "name"
                             }
                         },
                         Visibility = "visibility"
                     }
                 },
                 SelectableValues = new ParameterSelectableValuesProperty {
                     LinkToDataSetColumn = new ColumnIdentifierProperty {
                         ColumnName = "columnName",
                         DataSetIdentifier = "dataSetIdentifier"
                     },
                     Values = new [] { "values" }
                 },
                 Type = "type"
             };

Synopsis

Constructors

ParameterListControlProperty()

A control to display a list with buttons or boxes that are used to select either a single value or multiple values.

Properties

CascadingControlConfiguration	The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.
DisplayOptions	The display options of a control.
ParameterControlId	The ID of the ParameterListControl .
SelectableValues	A list of selectable values that are used in a control.
SourceParameterName	The source parameter name of the ParameterListControl .
Title	The title of the ParameterListControl .
Type	The type of ParameterListControl .

Constructors

ParameterListControlProperty()

A control to display a list with buttons or boxes that are used to select either a single value or multiple values.

public ParameterListControlProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterlistcontrol.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.QuickSight;

             var parameterListControlProperty = new ParameterListControlProperty {
                 ParameterControlId = "parameterControlId",
                 SourceParameterName = "sourceParameterName",
                 Title = "title",

                 // the properties below are optional
                 CascadingControlConfiguration = new CascadingControlConfigurationProperty {
                     SourceControls = new [] { new CascadingControlSourceProperty {
                         ColumnToMatch = new ColumnIdentifierProperty {
                             ColumnName = "columnName",
                             DataSetIdentifier = "dataSetIdentifier"
                         },
                         SourceSheetControlId = "sourceSheetControlId"
                     } }
                 },
                 DisplayOptions = new ListControlDisplayOptionsProperty {
                     InfoIconLabelOptions = new SheetControlInfoIconLabelOptionsProperty {
                         InfoIconText = "infoIconText",
                         Visibility = "visibility"
                     },
                     SearchOptions = new ListControlSearchOptionsProperty {
                         Visibility = "visibility"
                     },
                     SelectAllOptions = new ListControlSelectAllOptionsProperty {
                         Visibility = "visibility"
                     },
                     TitleOptions = new LabelOptionsProperty {
                         CustomLabel = "customLabel",
                         FontConfiguration = new FontConfigurationProperty {
                             FontColor = "fontColor",
                             FontDecoration = "fontDecoration",
                             FontFamily = "fontFamily",
                             FontSize = new FontSizeProperty {
                                 Absolute = "absolute",
                                 Relative = "relative"
                             },
                             FontStyle = "fontStyle",
                             FontWeight = new FontWeightProperty {
                                 Name = "name"
                             }
                         },
                         Visibility = "visibility"
                     }
                 },
                 SelectableValues = new ParameterSelectableValuesProperty {
                     LinkToDataSetColumn = new ColumnIdentifierProperty {
                         ColumnName = "columnName",
                         DataSetIdentifier = "dataSetIdentifier"
                     },
                     Values = new [] { "values" }
                 },
                 Type = "type"
             };

Properties

CascadingControlConfiguration

The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.

public object? CascadingControlConfiguration { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterlistcontrol.html#cfn-quicksight-template-parameterlistcontrol-cascadingcontrolconfiguration

DisplayOptions

The display options of a control.

public object? DisplayOptions { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterlistcontrol.html#cfn-quicksight-template-parameterlistcontrol-displayoptions

ParameterControlId

The ID of the ParameterListControl .

public string ParameterControlId { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterlistcontrol.html#cfn-quicksight-template-parameterlistcontrol-parametercontrolid

SelectableValues

A list of selectable values that are used in a control.

public object? SelectableValues { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterlistcontrol.html#cfn-quicksight-template-parameterlistcontrol-selectablevalues

SourceParameterName

The source parameter name of the ParameterListControl .

public string SourceParameterName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterlistcontrol.html#cfn-quicksight-template-parameterlistcontrol-sourceparametername

Title

The title of the ParameterListControl .

public string Title { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterlistcontrol.html#cfn-quicksight-template-parameterlistcontrol-title

Type

The type of ParameterListControl .

public string? Type { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterlistcontrol.html#cfn-quicksight-template-parameterlistcontrol-type

Implements

CfnTemplate.IParameterListControlProperty