zplCore.comzplCore.com

ZplFieldInfo

public record ZplFieldInfo

A variable ^FN field found by ZplFields.Find.

Constructors

SignatureDescription
# ZplFieldInfo(int Number, string Prompt, string Value, string Format, int Offset, int Count)A variable ^FN field found by ZplFields.Find. Number: Field number (^FN1 → 1). · Prompt: Prompt text of the first ^FN with one (^FN1"Name" → "Name"), or null. · Value: Data that prints without an override: the ^XF data block value, else the ^FD default of the field (null when none). · Format: Name of the stored format (^DF) the field belongs to, or null for fields of an ordinary label. · Offset: Source offset of the first ^FN command with this number. · Count: Number of fields with this number (stored formats and labels, ^XF data blocks not counted).

Properties

PropertyTypeDescription
Count { get; init; }intNumber of fields with this number (stored formats and labels, ^XF data blocks not counted).
Format { get; init; }stringName of the stored format (^DF) the field belongs to, or null for fields of an ordinary label.
Number { get; init; }intField number (^FN1 → 1).
Offset { get; init; }intSource offset of the first ^FN command with this number.
Prompt { get; init; }stringPrompt text of the first ^FN with one (^FN1"Name" → "Name"), or null.
Value { get; init; }stringData that prints without an override: the ^XF data block value, else the ^FD default of the field (null when none).

Methods

Method SignatureReturnsDescription
# Deconstruct(out int Number, out string Prompt, out string Value, out string Format, out int Offset, out int Count)void