Share via


CollectionTableValue<T> Class

Definition

Create a TableValue over a dotnet collection class. Depending on what collection interfaces it exposes will determine the capabilities (such as Enumeration, Count, Index).

public abstract class CollectionTableValue<T> : Microsoft.PowerFx.Types.TableValue
type CollectionTableValue<'T> = class
    inherit TableValue
Public MustInherit Class CollectionTableValue(Of T)
Inherits TableValue

Type Parameters

T

The element type of the collection.

Inheritance

Constructors

CollectionTableValue<T>(RecordType, IEnumerable<T>)

Fields

ValueName

Often marshalling an array will create a Single Column Tables with a single "Value" column.

(Inherited from TableValue)

Properties

CanShallowCopy (Inherited from FormulaValue)
IsColumn (Inherited from TableValue)
RecordType
Rows
Type (Inherited from TableValue)

Methods

AppendAsync(RecordValue, CancellationToken)
AsBoolean() (Inherited from FormulaValue)
AsDecimal() (Inherited from FormulaValue)
AsDouble() (Inherited from FormulaValue)
CastRecord(RecordValue, CancellationToken)

Casts record to the table's record type.

(Inherited from TableValue)
ClearAsync(CancellationToken)
Count()
FindAsync(RecordValue, CancellationToken, Boolean)

Execute a linear search for the matching record.

First(Boolean)
GetRowsHashCode() (Inherited from TableValue)
Index(Int32, Boolean)

With mutation support, lookup the record at the given 1-based index, or return an error value if out of range.

(Inherited from TableValue)
Index(Int32)

Lookup the record at the given 1-based index, or return an error value if out of range.

(Inherited from TableValue)
Last(Boolean)
Marshal(T)
MarshalInverse(RecordValue)
MatchesAsync(RecordValue, RecordValue, CancellationToken)
MaybeShallowCopy()

Before mutation operations, call MaybeShallowCopy() to make a copy of the value. For most values this is a no-op and will not make a copy. Only types which implement IMutationCopy will have the opportunity to provide a copy.

(Inherited from FormulaValue)
PatchAsync(RecordValue, CancellationToken)

Modifies a single record based on primary key within the record itself.

(Inherited from TableValue)
PatchAsync(RecordValue, RecordValue, CancellationToken)

Modifies one record in a data source.

(Inherited from TableValue)
PatchCoreAsync(RecordValue, RecordValue, CancellationToken)
PatchSingleRecordCoreAsync(RecordValue, CancellationToken)

Patch single record implementation for derived classes.

(Inherited from TableValue)
RemoveAsync(IEnumerable<FormulaValue>, Boolean, CancellationToken)
ToExpression()

Provides serialization. Return an expression that, when evaluated in the invariant locale, recreates an equivalent formula value, including its type. This may not be the same as the expression used to originally create this type.

(Inherited from FormulaValue)
ToExpression(StringBuilder, FormulaValueSerializerSettings) (Inherited from TableValue)
ToObject() (Inherited from TableValue)
TryGetIndex(Int32, DValue<RecordValue>, Boolean)
TryGetIndex(Int32, DValue<RecordValue>)
TryGetPrimitiveValue(Object) (Inherited from FormulaValue)
TryShallowCopy(FormulaValue) (Inherited from FormulaValue)
Visit(IValueVisitor) (Inherited from TableValue)

Extension Methods

CanCoerceToStringValue(FormulaValue)

Can convert value to String format or not.

TryCoerceTo(FormulaValue, RuntimeConfig, StringValue)

Try to convert value to String format.

TryCoerceTo(FormulaValue, RuntimeConfig, CancellationToken, StringValue)

Try to convert value to String format.

TryCoerceTo(FormulaValue, BooleanValue)

Try to convert value to Boolean format.

TryCoerceTo(FormulaValue, DateTimeValue)

Try to convert value to DateTime format.

TryCoerceTo(FormulaValue, DecimalValue)

Try to convert value to Number format.

TryCoerceTo(FormulaValue, FormulaType, FormulaValue)
TryCoerceTo(FormulaValue, NumberValue)

Try to convert value to Number format.

TryCoerceTo(FormulaValue, StringValue)

Try to convert value to String format.

TryCoerceToTable(TableValue, TableType, TableValue)

Applies to