Table of Contents

Class HtmlItemDefinition

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

One html item with the parameters it accepts, as GET htmlitems/{tagName} returns it.

public sealed record HtmlItemDefinition : IHtmlItemDefinition, IHtmlItem
Inheritance
object
HtmlItemDefinition
Implements

Properties

Category

What to group it under. "General" where the item states nothing else.

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

Property Value

string

Description

What the item does, for a CMS editor to show.

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

Property Value

string

Parameters

The attributes the tag takes.

[JsonPropertyName("parameters")]
public List<HtmlItemParameter>? Parameters { get; init; }

Property Value

List<HtmlItemParameter>

ReplacementParameters

The placeholders the item replaces inside its own templates.

[JsonPropertyName("replacementParameters")]
public List<HtmlItemReplacementParameter>? ReplacementParameters { get; init; }

Property Value

List<HtmlItemReplacementParameter>

TagName

The tag the render engine replaces, which is this item's id everywhere else.

[JsonPropertyName("tagName")]
public string? TagName { get; init; }

Property Value

string