Class MatrixHeader
Represents a collection of matrix header descriptors used in the MatrixObject.
Inheritance
Implements
Namespace: FastReport.Matrix
Assembly: FastReport.Base.dll
Syntax
public class MatrixHeader : CollectionBase, IList, ICollection, IEnumerable, IFRSerializableProperties
Item[Int32]
Gets or sets the element at the specified index.
Declaration
public MatrixHeaderDescriptor this[int index] { get; set; }Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index | Index of an element. |
Property Value
| Type | Description |
|---|---|
| MatrixHeaderDescriptor | The element at the specified index. |
Methods
Add(MatrixHeaderDescriptor)
Adds a descriptor to the end of this collection.
Declaration
public int Add(MatrixHeaderDescriptor value)Parameters
| Type | Name | Description |
|---|---|---|
| MatrixHeaderDescriptor | value | Descriptor to add. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Index of the added descriptor. |
AddRange(MatrixHeaderDescriptor[])
Adds the specified descriptors to the end of this collection.
Declaration
public void AddRange(MatrixHeaderDescriptor[] range)Parameters
| Type | Name | Description |
|---|---|---|
| MatrixHeaderDescriptor[] | range | Array of descriptors to add. |
Contains(MatrixHeaderDescriptor)
Determines whether a descriptor is in the collection.
Declaration
public bool Contains(MatrixHeaderDescriptor value)Parameters
| Type | Name | Description |
|---|---|---|
| MatrixHeaderDescriptor | value | The descriptor to locate in the collection. |
Returns
| Type | Description |
|---|---|
| System.Boolean | true if descriptor is found in the collection; otherwise, false. |
Deserialize(FRReader)
Deserializes the object.
Declaration
public void Deserialize(FRReader reader)Parameters
| Type | Name | Description |
|---|---|---|
| FRReader | reader | Reader object. |
Find(Object[])
Gets an index of header with the address specified.
Declaration
public int Find(object[] address)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object[] | address | The address of a header. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The index of header. |
FindOrCreate(Object[])
Gets an index of header with the address specified. If there is no such header item, it will be created.
Declaration
public int FindOrCreate(object[] address)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object[] | address | The address of a header. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The index of header. |
GetTerminalIndices()
Gets the list of indices of terminal items of this header.
Declaration
public int[] GetTerminalIndices()Returns
| Type | Description |
|---|---|
| System.Int32[] | The list of indices. |
GetTerminalIndices(Object[])
Gets the list of indices of terminal items of the header with specified address.
Declaration
public int[] GetTerminalIndices(object[] address)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object[] | address | The address of a header. |
Returns
| Type | Description |
|---|---|
| System.Int32[] | The list of indices. |
IndexOf(MatrixHeaderDescriptor)
Returns the zero-based index of the first occurrence of a descriptor.
Declaration
public int IndexOf(MatrixHeaderDescriptor value)Parameters
| Type | Name | Description |
|---|---|---|
| MatrixHeaderDescriptor | value | The descriptor to locate in the collection. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The zero-based index of the first occurrence of descriptor within the entire collection, if found; otherwise, -1. |
Insert(Int32, MatrixHeaderDescriptor)
Inserts a descriptor into this collection at the specified index.
Declaration
public void Insert(int index, MatrixHeaderDescriptor value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index | The zero-based index at which value should be inserted. |
| MatrixHeaderDescriptor | value | The descriptor to insert. |
Remove(MatrixHeaderDescriptor)
Removes the specified descriptor from the collection.
Declaration
public void Remove(MatrixHeaderDescriptor value)Parameters
| Type | Name | Description |
|---|---|---|
| MatrixHeaderDescriptor | value | Descriptor to remove. |
RemoveItem(Object[])
Removes a header item with the address specified.
Declaration
public void RemoveItem(object[] address)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object[] | address | The address of a header. |
Serialize(FRWriter)
Serializes the object.
Declaration
public void Serialize(FRWriter writer)Parameters
| Type | Name | Description |
|---|---|---|
| FRWriter | writer | Writer object. |
ToArray()
Copies the elements of this collection to a new array.
Declaration
public MatrixHeaderDescriptor[] ToArray()Returns
| Type | Description |
|---|---|
| MatrixHeaderDescriptor[] | An array containing copies of this collection elements. |