QRCode Class
Represents a generated QR code as a boolean matrix of modules.
public sealed class QRCodeProperties
| Name | Description |
|---|---|
| ErrorCorrectionLevel | Gets the error correction level the symbol was built with. |
| Height | Gets the height (number of rows). |
| Size | Gets the side length for square QR codes (same as QRCode.Width). |
| StructuredAppend | Gets the place of the symbol in a structured append sequence, or null when the symbol holds all of its data. |
| Type | Gets the type of QR code. |
| Version | Gets the QR code version. |
| Width | Gets the width (number of columns). |
ErrorCorrectionLevel
QRCode.csGets the error correction level the symbol was built with.
public ErrorCorrectionLevel ErrorCorrectionLevel { get; }Property value
Remarks
This can differ from the requested level. Micro QR version M1 carries error detection only, and is reported as ErrorCorrectionLevel.L because the enumeration has no weaker member.
Height
QRCode.csSize
QRCode.csGets the side length for square QR codes (same as QRCode.Width).
public int Size { get; }Property value
StructuredAppend
QRCode.csGets the place of the symbol in a structured append sequence, or null when the symbol holds all of its data.
public QRCodeStructuredAppend? StructuredAppend { get; }Type
QRCode.csVersion
QRCode.csWidth
QRCode.csIndexers
| Name | Description |
|---|---|
| this[int, int] | Gets whether the module at the specified position is dark. |
this[int, int]
QRCode.csMethods
| Name | Description |
|---|---|
| Create(IEnumerable<QRCodeSegment>, ErrorCorrectionLevel) | Creates a standard QR code from segments of data that you choose. |
| Create(IEnumerable<QRCodeSegment>, ErrorCorrectionLevel, QRCodeOptions?) | Creates a standard QR code from segments of data that you choose. |
| Create(ReadOnlySpan<byte>, ErrorCorrectionLevel) | Creates a standard QR code from the specified binary data. |
| Create(ReadOnlySpan<byte>, ErrorCorrectionLevel, QRCodeOptions?) | Creates a standard QR code from the specified binary data. |
| Create(string, ErrorCorrectionLevel) | Creates a standard QR code from the specified text data. |
| Create(string, ErrorCorrectionLevel, QRCodeOptions?) | Creates a standard QR code from the specified text data. |
| CreateMicroQR(IEnumerable<QRCodeSegment>, ErrorCorrectionLevel) | Creates a Micro QR code from segments of data that you choose. |
| CreateMicroQR(IEnumerable<QRCodeSegment>, ErrorCorrectionLevel, MicroQRCodeOptions?) | Creates a Micro QR code from segments of data that you choose. |
| CreateMicroQR(string, ErrorCorrectionLevel) | Creates a Micro QR code from the specified text data. Micro QR codes are smaller (versions M1-M4, 11x11 to 17x17 modules) and have a single finder pattern. |
| CreateMicroQR(string, ErrorCorrectionLevel, MicroQRCodeOptions?) | Creates a Micro QR code from the specified text data. Micro QR codes are smaller (versions M1-M4, 11x11 to 17x17 modules) and have a single finder pattern. |
| CreateRMQR(IEnumerable<QRCodeSegment>, ErrorCorrectionLevel) | Creates a Rectangular Micro QR code (rMQR) from segments of data that you choose. |
| CreateRMQR(IEnumerable<QRCodeSegment>, ErrorCorrectionLevel, RMQRCodeOptions?) | Creates a Rectangular Micro QR code (rMQR) from segments of data that you choose. |
| CreateRMQR(string, ErrorCorrectionLevel) | Creates a Rectangular Micro QR code (rMQR) from the specified text data. rMQR codes are rectangular and optimized for narrow spaces. |
| CreateRMQR(string, ErrorCorrectionLevel, RMQRCodeOptions?) | Creates a Rectangular Micro QR code (rMQR) from the specified text data. rMQR codes are rectangular and optimized for narrow spaces. |
| CreateStructuredAppend(IEnumerable<QRCodeSegment>, ErrorCorrectionLevel) | Creates a structured append sequence: standard QR codes that each hold a part of segments of data that you choose. |
| CreateStructuredAppend(IEnumerable<QRCodeSegment>, ErrorCorrectionLevel, QRCodeOptions?) | Creates a structured append sequence: standard QR codes that each hold a part of segments of data that you choose. |
| CreateStructuredAppend(ReadOnlySpan<byte>, ErrorCorrectionLevel) | Creates a structured append sequence: standard QR codes that each hold a part of binary data. |
| CreateStructuredAppend(ReadOnlySpan<byte>, ErrorCorrectionLevel, QRCodeOptions?) | Creates a structured append sequence: standard QR codes that each hold a part of binary data. |
| CreateStructuredAppend(string, ErrorCorrectionLevel) | Creates a structured append sequence: standard QR codes that each hold a part of a text, for data too large for one symbol or to print several smaller symbols. |
| CreateStructuredAppend(string, ErrorCorrectionLevel, QRCodeOptions?) | Creates a structured append sequence: standard QR codes that each hold a part of a text, for data too large for one symbol or to print several smaller symbols. |
Create overloads
Create(IEnumerable<QRCodeSegment>, ErrorCorrectionLevel)
QRCode.csCreates a standard QR code from segments of data that you choose.
public static QRCode Create(IEnumerable<QRCodeSegment> segments, ErrorCorrectionLevel errorCorrectionLevel = ErrorCorrectionLevel.M)Parameters
segmentsIEnumerable<QRCodeSegment>- The segments, in order.
errorCorrectionLevelErrorCorrectionLevel- The error correction level.
Returns
Exceptions
ArgumentNullExceptionsegmentsisnull.ArgumentExceptionsegmentshas anullelement, or has no segment of data.ArgumentOutOfRangeExceptionerrorCorrectionLevelis not a definedErrorCorrectionLevelvalue.InvalidOperationException- The data does not fit in the largest version.
Create(IEnumerable<QRCodeSegment>, ErrorCorrectionLevel, QRCodeOptions?)
QRCode.csCreates a standard QR code from segments of data that you choose.
public static QRCode Create(IEnumerable<QRCodeSegment> segments, ErrorCorrectionLevel errorCorrectionLevel, QRCodeOptions? options)Parameters
segmentsIEnumerable<QRCodeSegment>- The segments, in order.
errorCorrectionLevelErrorCorrectionLevel- The error correction level.
optionsQRCodeOptions?- The options, or
nullfor the defaults.
Returns
Exceptions
ArgumentNullExceptionsegmentsisnull.ArgumentExceptionsegmentshas anullelement, or has no segment of data, orQRCodeOptions.MinimumVersionis greater thanQRCodeOptions.MaximumVersion.ArgumentOutOfRangeExceptionerrorCorrectionLevelis not a definedErrorCorrectionLevelvalue.InvalidOperationException- The data does not fit in the largest allowed version.
Remarks
The segments are encoded as they are, in order, preceded by an ECI designator when QRCodeOptions.EciAssignmentNumber is set.
Example
// An ISO-8859-1 text followed by a long number: the text in byte mode, after an ECI designator that declares its
// encoding (assignment number 3), and the digits in numeric mode
QRCodeSegment[] segments =
[
QRCodeSegment.CreateEci(3),
QRCodeSegment.CreateByte(Encoding.Latin1.GetBytes("Facture n\u00B0")),
QRCodeSegment.CreateNumeric("12345678901234567890123456789012345"),
];
var qrCode = QRCode.Create(segments, ErrorCorrectionLevel.M);
// The same bytes in a single byte segment need a larger symbol
var bytes = Encoding.Latin1.GetBytes("Facture n\u00B012345678901234567890123456789012345");
var singleSegment = QRCode.Create(bytes, ErrorCorrectionLevel.M, new QRCodeOptions { EciAssignmentNumber = 3 });
Assert.Equal((3, 4), (qrCode.Version, singleSegment.Version));Create(ReadOnlySpan<byte>, ErrorCorrectionLevel)
QRCode.csCreates a standard QR code from the specified binary data.
public static QRCode Create(ReadOnlySpan<byte> data, ErrorCorrectionLevel errorCorrectionLevel = ErrorCorrectionLevel.M)Parameters
dataReadOnlySpan<byte>- The binary data to encode.
errorCorrectionLevelErrorCorrectionLevel- The error correction level.
Returns
Exceptions
ArgumentOutOfRangeExceptionerrorCorrectionLevelis not a definedErrorCorrectionLevelvalue.
Create(ReadOnlySpan<byte>, ErrorCorrectionLevel, QRCodeOptions?)
QRCode.csCreates a standard QR code from the specified binary data.
public static QRCode Create(ReadOnlySpan<byte> data, ErrorCorrectionLevel errorCorrectionLevel, QRCodeOptions? options)Parameters
dataReadOnlySpan<byte>- The binary data to encode.
errorCorrectionLevelErrorCorrectionLevel- The error correction level.
optionsQRCodeOptions?- The options, or
nullfor the defaults.
Returns
Exceptions
ArgumentOutOfRangeExceptionerrorCorrectionLevelis not a definedErrorCorrectionLevelvalue.ArgumentExceptionQRCodeOptions.MinimumVersionis greater thanQRCodeOptions.MaximumVersion.InvalidOperationException- The data does not fit in the largest allowed version.
Remarks
The bytes are encoded as they are, in byte mode, preceded by an ECI designator when QRCodeOptions.EciAssignmentNumber is set.
Create(string, ErrorCorrectionLevel)
QRCode.csCreates a standard QR code from the specified text data.
public static QRCode Create(string data, ErrorCorrectionLevel errorCorrectionLevel = ErrorCorrectionLevel.M)Parameters
datastring- The text data to encode.
errorCorrectionLevelErrorCorrectionLevel- The error correction level.
Returns
Exceptions
ArgumentOutOfRangeExceptionerrorCorrectionLevelis not a definedErrorCorrectionLevelvalue.
Create(string, ErrorCorrectionLevel, QRCodeOptions?)
QRCode.csCreates a standard QR code from the specified text data.
public static QRCode Create(string data, ErrorCorrectionLevel errorCorrectionLevel, QRCodeOptions? options)Parameters
datastring- The text data to encode.
errorCorrectionLevelErrorCorrectionLevel- The error correction level.
optionsQRCodeOptions?- The options, or
nullfor the defaults.
Returns
Exceptions
ArgumentOutOfRangeExceptionerrorCorrectionLevelis not a definedErrorCorrectionLevelvalue.ArgumentExceptionQRCodeOptions.EciAssignmentNumberis notnullorQRCodeOptions.Utf8EciAssignmentNumber, orQRCodeOptions.MinimumVersionis greater thanQRCodeOptions.MaximumVersion.InvalidOperationException- The data does not fit in the largest allowed version.
Remarks
The text is encoded as UTF-8, without an ECI designator unless QRCodeOptions.EciAssignmentNumber is QRCodeOptions.Utf8EciAssignmentNumber.
CreateMicroQR overloads
CreateMicroQR(IEnumerable<QRCodeSegment>, ErrorCorrectionLevel)
QRCode.csCreates a Micro QR code from segments of data that you choose.
public static QRCode CreateMicroQR(IEnumerable<QRCodeSegment> segments, ErrorCorrectionLevel errorCorrectionLevel = ErrorCorrectionLevel.L)Parameters
segmentsIEnumerable<QRCodeSegment>- The segments, in order.
errorCorrectionLevelErrorCorrectionLevel- The error correction level. M1 only supports detection; M2/M3 support L/M; M4 supports L/M/Q.
Returns
Exceptions
ArgumentNullExceptionsegmentsisnull.ArgumentExceptionsegmentshas anullelement or an ECI designator, or has no segment of data.ArgumentOutOfRangeExceptionerrorCorrectionLevelis notErrorCorrectionLevel.L,ErrorCorrectionLevel.MorErrorCorrectionLevel.Q.InvalidOperationException- The data does not fit in the largest version, or has a mode these versions cannot encode.
CreateMicroQR(IEnumerable<QRCodeSegment>, ErrorCorrectionLevel, MicroQRCodeOptions?)
QRCode.csCreates a Micro QR code from segments of data that you choose.
public static QRCode CreateMicroQR(IEnumerable<QRCodeSegment> segments, ErrorCorrectionLevel errorCorrectionLevel, MicroQRCodeOptions? options)Parameters
segmentsIEnumerable<QRCodeSegment>- The segments, in order.
errorCorrectionLevelErrorCorrectionLevel- The error correction level. M1 only supports detection; M2/M3 support L/M; M4 supports L/M/Q.
optionsMicroQRCodeOptions?- The options, or
nullfor the defaults.
Returns
Exceptions
ArgumentNullExceptionsegmentsisnull.ArgumentExceptionsegmentshas anullelement or an ECI designator, or has no segment of data; orMicroQRCodeOptions.MinimumVersionis greater thanMicroQRCodeOptions.MaximumVersion, or no version of this range supportserrorCorrectionLevel.ArgumentOutOfRangeExceptionerrorCorrectionLevelis notErrorCorrectionLevel.L,ErrorCorrectionLevel.MorErrorCorrectionLevel.Q.InvalidOperationException- The data does not fit in the largest allowed version, or has a mode these versions cannot encode.
Remarks
M1 holds a single numeric segment, M2 numeric and alphanumeric segments, M3 and M4 every mode. Micro QR codes do not have ECI designators.
CreateMicroQR(string, ErrorCorrectionLevel)
QRCode.csCreates a Micro QR code from the specified text data. Micro QR codes are smaller (versions M1-M4, 11x11 to 17x17 modules) and have a single finder pattern.
public static QRCode CreateMicroQR(string data, ErrorCorrectionLevel errorCorrectionLevel = ErrorCorrectionLevel.L)Parameters
datastring- The text data to encode.
errorCorrectionLevelErrorCorrectionLevel- The error correction level. M1 only supports detection; M2/M3 support L/M; M4 supports L/M/Q.
Returns
Exceptions
ArgumentOutOfRangeExceptionerrorCorrectionLevelis notErrorCorrectionLevel.L,ErrorCorrectionLevel.MorErrorCorrectionLevel.Q.
CreateMicroQR(string, ErrorCorrectionLevel, MicroQRCodeOptions?)
QRCode.csCreates a Micro QR code from the specified text data. Micro QR codes are smaller (versions M1-M4, 11x11 to 17x17 modules) and have a single finder pattern.
public static QRCode CreateMicroQR(string data, ErrorCorrectionLevel errorCorrectionLevel, MicroQRCodeOptions? options)Parameters
datastring- The text data to encode.
errorCorrectionLevelErrorCorrectionLevel- The error correction level. M1 only supports detection; M2/M3 support L/M; M4 supports L/M/Q.
optionsMicroQRCodeOptions?- The options, or
nullfor the defaults.
Returns
Exceptions
ArgumentOutOfRangeExceptionerrorCorrectionLevelis notErrorCorrectionLevel.L,ErrorCorrectionLevel.MorErrorCorrectionLevel.Q.ArgumentExceptionMicroQRCodeOptions.MinimumVersionis greater thanMicroQRCodeOptions.MaximumVersion, or no version of this range supportserrorCorrectionLevel.InvalidOperationException- The data does not fit in the largest allowed version, or has characters these versions cannot encode.
CreateRMQR overloads
CreateRMQR(IEnumerable<QRCodeSegment>, ErrorCorrectionLevel)
QRCode.csCreates a Rectangular Micro QR code (rMQR) from segments of data that you choose.
public static QRCode CreateRMQR(IEnumerable<QRCodeSegment> segments, ErrorCorrectionLevel errorCorrectionLevel = ErrorCorrectionLevel.M)Parameters
segmentsIEnumerable<QRCodeSegment>- The segments, in order.
errorCorrectionLevelErrorCorrectionLevel- The error correction level. Only M and H are supported.
Returns
Exceptions
ArgumentNullExceptionsegmentsisnull.ArgumentExceptionsegmentshas anullelement or an ECI designator, or has no segment of data.ArgumentOutOfRangeExceptionerrorCorrectionLevelis notErrorCorrectionLevel.MorErrorCorrectionLevel.H.InvalidOperationException- The data does not fit in the largest size.
CreateRMQR(IEnumerable<QRCodeSegment>, ErrorCorrectionLevel, RMQRCodeOptions?)
QRCode.csCreates a Rectangular Micro QR code (rMQR) from segments of data that you choose.
public static QRCode CreateRMQR(IEnumerable<QRCodeSegment> segments, ErrorCorrectionLevel errorCorrectionLevel, RMQRCodeOptions? options)Parameters
segmentsIEnumerable<QRCodeSegment>- The segments, in order.
errorCorrectionLevelErrorCorrectionLevel- The error correction level. Only M and H are supported.
optionsRMQRCodeOptions?- The options, or
nullfor the defaults.
Returns
Exceptions
ArgumentNullExceptionsegmentsisnull.ArgumentExceptionsegmentshas anullelement or an ECI designator, or has no segment of data; or no rMQR size satisfies the size constraints ofoptions.ArgumentOutOfRangeExceptionerrorCorrectionLevelis notErrorCorrectionLevel.MorErrorCorrectionLevel.H.InvalidOperationException- The data does not fit in the largest allowed size.
Remarks
rMQR codes do not have ECI designators.
CreateRMQR(string, ErrorCorrectionLevel)
QRCode.csCreates a Rectangular Micro QR code (rMQR) from the specified text data. rMQR codes are rectangular and optimized for narrow spaces.
public static QRCode CreateRMQR(string data, ErrorCorrectionLevel errorCorrectionLevel = ErrorCorrectionLevel.M)Parameters
datastring- The text data to encode.
errorCorrectionLevelErrorCorrectionLevel- The error correction level. Only M and H are supported.
Returns
Exceptions
ArgumentOutOfRangeExceptionerrorCorrectionLevelis notErrorCorrectionLevel.MorErrorCorrectionLevel.H.
CreateRMQR(string, ErrorCorrectionLevel, RMQRCodeOptions?)
QRCode.csCreates a Rectangular Micro QR code (rMQR) from the specified text data. rMQR codes are rectangular and optimized for narrow spaces.
public static QRCode CreateRMQR(string data, ErrorCorrectionLevel errorCorrectionLevel, RMQRCodeOptions? options)Parameters
datastring- The text data to encode.
errorCorrectionLevelErrorCorrectionLevel- The error correction level. Only M and H are supported.
optionsRMQRCodeOptions?- The options, or
nullfor the defaults.
Returns
Exceptions
ArgumentOutOfRangeExceptionerrorCorrectionLevelis notErrorCorrectionLevel.MorErrorCorrectionLevel.H.ArgumentException- No rMQR size satisfies the size constraints of
options. InvalidOperationException- The data does not fit in the largest allowed size.
CreateStructuredAppend overloads
CreateStructuredAppend(IEnumerable<QRCodeSegment>, ErrorCorrectionLevel)
QRCode.csCreates a structured append sequence: standard QR codes that each hold a part of segments of data that you choose.
public static IReadOnlyList<QRCode> CreateStructuredAppend(IEnumerable<QRCodeSegment> segments, ErrorCorrectionLevel errorCorrectionLevel = ErrorCorrectionLevel.M)Parameters
segmentsIEnumerable<QRCodeSegment>- The segments, in order.
errorCorrectionLevelErrorCorrectionLevel- The error correction level.
Returns
IReadOnlyList<QRCode> The symbols of the sequence, in order.
Exceptions
ArgumentNullExceptionsegmentsisnull.ArgumentExceptionsegmentshas anullelement, or has no segment of data.ArgumentOutOfRangeExceptionerrorCorrectionLevelis not a definedErrorCorrectionLevelvalue.InvalidOperationException- The data does not fit in 16 symbols of the largest version.
CreateStructuredAppend(IEnumerable<QRCodeSegment>, ErrorCorrectionLevel, QRCodeOptions?)
QRCode.csCreates a structured append sequence: standard QR codes that each hold a part of segments of data that you choose.
public static IReadOnlyList<QRCode> CreateStructuredAppend(IEnumerable<QRCodeSegment> segments, ErrorCorrectionLevel errorCorrectionLevel, QRCodeOptions? options)Parameters
segmentsIEnumerable<QRCodeSegment>- The segments, in order.
errorCorrectionLevelErrorCorrectionLevel- The error correction level.
optionsQRCodeOptions?- The options, or
nullfor the defaults.
Returns
IReadOnlyList<QRCode> The symbols of the sequence, in order.
Exceptions
ArgumentNullExceptionsegmentsisnull.ArgumentExceptionsegmentshas anullelement, or has no segment of data, orQRCodeOptions.MinimumVersionis greater thanQRCodeOptions.MaximumVersion.ArgumentOutOfRangeExceptionerrorCorrectionLevelis not a definedErrorCorrectionLevelvalue.InvalidOperationException- The data does not fit in 16 symbols of the largest allowed version.
Remarks
A segment can be split across two symbols, between two characters (or two bytes in byte mode). Each symbol repeats the ECI designator in force at its start. The symbols are chosen as by QRCode.CreateStructuredAppend.
CreateStructuredAppend(ReadOnlySpan<byte>, ErrorCorrectionLevel)
QRCode.csCreates a structured append sequence: standard QR codes that each hold a part of binary data.
public static IReadOnlyList<QRCode> CreateStructuredAppend(ReadOnlySpan<byte> data, ErrorCorrectionLevel errorCorrectionLevel = ErrorCorrectionLevel.M)Parameters
dataReadOnlySpan<byte>- The binary data to encode.
errorCorrectionLevelErrorCorrectionLevel- The error correction level.
Returns
IReadOnlyList<QRCode> The symbols of the sequence, in order.
Exceptions
ArgumentOutOfRangeExceptionerrorCorrectionLevelis not a definedErrorCorrectionLevelvalue.InvalidOperationException- The data does not fit in 16 symbols of the largest version.
CreateStructuredAppend(ReadOnlySpan<byte>, ErrorCorrectionLevel, QRCodeOptions?)
QRCode.csCreates a structured append sequence: standard QR codes that each hold a part of binary data.
public static IReadOnlyList<QRCode> CreateStructuredAppend(ReadOnlySpan<byte> data, ErrorCorrectionLevel errorCorrectionLevel, QRCodeOptions? options)Parameters
dataReadOnlySpan<byte>- The binary data to encode.
errorCorrectionLevelErrorCorrectionLevel- The error correction level.
optionsQRCodeOptions?- The options, or
nullfor the defaults.
Returns
IReadOnlyList<QRCode> The symbols of the sequence, in order.
Exceptions
ArgumentOutOfRangeExceptionerrorCorrectionLevelis not a definedErrorCorrectionLevelvalue.ArgumentExceptionQRCodeOptions.MinimumVersionis greater thanQRCodeOptions.MaximumVersion.InvalidOperationException- The data does not fit in 16 symbols of the largest allowed version.
Remarks
The bytes are encoded as they are, in byte mode, and the symbols are chosen as by QRCode.CreateStructuredAppend. A symbol can end in the middle of a multi-byte character.
CreateStructuredAppend(string, ErrorCorrectionLevel)
QRCode.csCreates a structured append sequence: standard QR codes that each hold a part of a text, for data too large for one symbol or to print several smaller symbols.
public static IReadOnlyList<QRCode> CreateStructuredAppend(string data, ErrorCorrectionLevel errorCorrectionLevel = ErrorCorrectionLevel.M)Parameters
datastring- The text data to encode.
errorCorrectionLevelErrorCorrectionLevel- The error correction level.
Returns
IReadOnlyList<QRCode> The symbols of the sequence, in order.
Exceptions
ArgumentOutOfRangeExceptionerrorCorrectionLevelis not a definedErrorCorrectionLevelvalue.InvalidOperationException- The data does not fit in 16 symbols of the largest version.
CreateStructuredAppend(string, ErrorCorrectionLevel, QRCodeOptions?)
QRCode.csCreates a structured append sequence: standard QR codes that each hold a part of a text, for data too large for one symbol or to print several smaller symbols.
public static IReadOnlyList<QRCode> CreateStructuredAppend(string data, ErrorCorrectionLevel errorCorrectionLevel, QRCodeOptions? options)Parameters
datastring- The text data to encode.
errorCorrectionLevelErrorCorrectionLevel- The error correction level.
optionsQRCodeOptions?- The options, or
nullfor the defaults.QRCodeOptions.MaximumVersionsets the largest symbols, andQRCodeOptions.MinimumVersionthe smallest ones.
Returns
IReadOnlyList<QRCode> The symbols of the sequence, in order.
Exceptions
ArgumentOutOfRangeExceptionerrorCorrectionLevelis not a definedErrorCorrectionLevelvalue.ArgumentExceptionQRCodeOptions.EciAssignmentNumberis notnullorQRCodeOptions.Utf8EciAssignmentNumber, orQRCodeOptions.MinimumVersionis greater thanQRCodeOptions.MaximumVersion.InvalidOperationException- The data does not fit in 16 symbols of the largest allowed version.
Remarks
The sequence has the fewest symbols that a version from QRCodeOptions.MinimumVersion to QRCodeOptions.MaximumVersion gives, up to 16, then every symbol has the smallest version that gives as few symbols. Each symbol is split into segments of different modes like a symbol of QRCode.Create, never in the middle of a surrogate pair, and repeats the ECI designator of QRCodeOptions.EciAssignmentNumber.
Data that fits in one symbol gives a sequence of one symbol. Readers that support structured append put the data back together; other readers read each symbol alone.
Example
var data = string.Concat(Enumerable.Repeat("The quick brown fox jumps over the lazy dog. ", 30));
// Symbols of version 10 at most (57 × 57 modules), instead of one symbol of version 30 (137 × 137 modules)
var symbols = QRCode.CreateStructuredAppend(data, ErrorCorrectionLevel.M, new QRCodeOptions { MaximumVersion = 10 });
Assert.Equal(7, symbols.Count);
Assert.Equal((10, 30), (symbols[0].Version, QRCode.Create(data, ErrorCorrectionLevel.M).Version));
// Each symbol knows its position in the sequence
Assert.Equal((0, 7), (symbols[0].StructuredAppend!.Index, symbols[0].StructuredAppend!.Count));
Assert.Equal((6, 7), (symbols[6].StructuredAppend!.Index, symbols[6].StructuredAppend!.Count));
// Print the symbols in order, side by side
var documents = symbols.Select(symbol => symbol.ToSvg(new QRCodeRenderOptions { ModuleSize = 4 })).ToList();