Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

HtmlRenderFormField

OfficeIMO.Html

Namespace
OfficeIMO.Html
Assembly
OfficeIMO.Html
Source revision
ac7e6e1bad8a with working tree changes
Modifiers
sealed

Backend-neutral standard HTML form metadata paired with static fallback visuals. Image and SVG backends paint HtmlRenderFormField.Visuals; interactive-capable backends may emit a native widget instead.

Inheritance

Properties

public HtmlRenderFormFieldKind FieldKind { get; } #

Resolved native field kind.

public string Name { get; } #

Stable field name from HTML name/id semantics or a deterministic renderer fallback.

public string MappingName { get; } #

Original HTML field name retained for export and mapping workflows.

public string Value { get; } #

Resolved scalar field value.

public string Placeholder { get; } #

Placeholder text shown only by the initial appearance while HtmlRenderFormField.Value is empty.

public IReadOnlyList<string> Values { get; } #

Resolved selected values for a choice field.

public IReadOnlyList<string> Options { get; } #

Resolved display options for a choice field.

public IReadOnlyList<string> OptionValues { get; } #

Export values corresponding by index to HtmlRenderFormField.Options.

public IReadOnlyList<int> SelectedOptionIndices { get; } #

Zero-based option identities selected by the HTML control.

public string? RadioOption { get; } #

PDF-safe appearance-state token for a check box or radio widget.

public bool IsSelected { get; } #

Whether a check box or radio widget is selected.

public bool IsDisabled { get; } #

Whether the HTML control is disabled and must not participate in form export.

public bool IsReadOnly { get; } #

Whether user editing is disabled by disabled or readonly HTML semantics.

public bool IsRequired { get; } #

Whether HTML requires a value.

public bool IsMultiline { get; } #

Whether text accepts multiple lines.

public bool IsPassword { get; } #

Whether text is password content.

public bool IsFileSelect { get; } #

Whether text represents a file selector.

public bool IsComboBox { get; } #

Whether a choice field uses a compact drop-down presentation.

public bool AllowsMultipleSelection { get; } #

Whether a choice field permits multiple selected options.

public int? MaximumLength { get; } #

Optional positive maximum text length.

public string? AlternateName { get; } #

Accessible field description derived from HTML/ARIA naming.

public OfficeFontInfo Font { get; } #

Resolved control font.

public OfficeColor TextColor { get; } #

Resolved text color.

public OfficeColor PlaceholderTextColor { get; } #

Resolved color used by the placeholder-only initial appearance.

public OfficeTextAlignment TextAlignment { get; } #

Resolved horizontal text alignment.

public OfficeColor? BackgroundColor { get; } #

Resolved background color.

public OfficeColor? BorderColor { get; } #

Resolved border color.

public string BorderStyle { get; } #

Resolved uniform CSS border style retained for interactive backends.

public double BorderWidth { get; } #

Resolved border width in CSS pixels.

public double CornerRadius { get; } #

Resolved uniform circular corner radius in CSS pixels.

public IReadOnlyList<HtmlRenderVisual> Visuals { get; } #

Ordered static fallback paint used by non-interactive backends.