Table of Contents

Class HtmlItemParameter

Namespace
BiExcellence.OpenBi.Api.HtmlItems
Assembly
BiExcellence.OpenBi.Api.Client.dll

One attribute an html item takes.

public sealed record HtmlItemParameter : IHtmlItemParameter
Inheritance
object
HtmlItemParameter
Implements

Properties

Category

What to group the attribute under in an editor.

[JsonPropertyName("category")]
public string? Category { get; init; }

Property Value

string

DefaultValue

What it means when the tag does not state it.

[JsonPropertyName("defaultValue")]
public string? DefaultValue { get; init; }

Property Value

string

Description

What the attribute is for.

[JsonPropertyName("description")]
public string? Description { get; init; }

Property Value

string

IsMultiple

Whether it takes more than one of those values.

[JsonPropertyName("isMultiple")]
public bool IsMultiple { get; init; }

Property Value

bool

Name

The attribute's name, as it is written on the tag.

[JsonPropertyName("name")]
public string? Name { get; init; }

Property Value

string

Type

What kind of value it takes - "Text", "Template", "Boolean", "Usergroup" and so on. A name rather than a number, and an editor uses it to decide which field to offer. Left as a string: the server may know a kind this client does not.

[JsonPropertyName("type")]
public string? Type { get; init; }

Property Value

string

Values

The values it is restricted to, where it is restricted at all. Usually empty.

[JsonPropertyName("values")]
public List<string>? Values { get; init; }

Property Value

List<string>