API Reference
ShapeOptions
Options for ValueShaper: how records are read and how values become text.
Inheritance
- Object
- ShapeOptions
Usage
Explore 14 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 1
- Method ShapeOptions.Clone
Accepted by parameters 13
- Method ShapeBudget.For
- Method ValueJson.Serialize
- Method ValueShaper.Cell
- Method ValueShaper.Fields
- Method ValueShaper.FindAdapter
- Method ValueShaper.Flatten
- Method ValueShaper.Prepare
- Method ValueShaper.ScalarText
- Method ValueShaper.ShapeOf
- Method ValueShaper.Text
- Method ValueShaper.Title
- Method ValueShaper.TryGetField
- Method ValueShaper.TypeName
Constructors
public ShapeOptions() #Methods
public ShapeOptions Clone() #ShapeOptionsA copy with the same adapters, delegates and limits.
Returns
The copy.
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public IList<IMemberSource> Sources { get; } #Record adapters tried before the built-in ones (for example PowerShell objects).
public Func<Object, Object>? Unwrap { get; set; } #Turns a wrapper into the value it wraps (for example a PowerShell object into its base object), or null.
public Func<Object, Object>? Identity { get; set; } #The identity of a value for cycle detection (for example the object a host wrapper wraps, since a new wrapper can be created for every read), or null to use the value itself.
public Func<Object, IEnumerable<String>>? TypeNames { get; set; } #Extra type names for a value (for example PowerShell type names), used to find registered shapers, or null.
public CollectionDisplay Collections { get; set; } #How collections are written inside cells and titles (default CollectionDisplay.Join).
public String Separator { get; set; } #The separator for CollectionDisplay.Join and CollectionDisplay.FirstN (default ", ").
public Int32 ItemLimit { get; set; } #How many items a collection shows before the "+N" marker (default 5).
public CultureInfo? Culture { get; set; } #The culture for numbers and dates, or null for the current culture.
public Boolean UseReflection { get; set; } #Whether plain .NET objects may be read through reflection (default true). Callers using trimming must preserve those public members, or set this to false and supply explicit adapters or shapers. Adapter-only mode does not make arbitrary caller delegates or adapters trim-safe.
public Int32 MaxFields { get; set; } #The most fields a record contributes as default columns (default 12).
public TimeSpan TimeBudget { get; set; } #How long one shaping pass (a table, a list, a tree) may spend reading values (default 2 seconds).
public Int32 MaxNodes { get; set; } #How many values one shaping pass may read (default 20 000).
public CultureInfo ResolvedCulture { get; } #The culture to format with: ShapeOptions.Culture or the current culture.