efc2bc7c cacc 6410 46d5 78e7d31f0cae - akesseler/Plexdata.Utilities.Templates GitHub Wiki

Options Class

This class represents the options to configure the template formatter.

Inheritance Hierarchy

System.Object
  Plexdata.Utilities.Formatting.Options
Namespace: Plexdata.Utilities.Formatting
Assembly: Plexdata.Utilities.Templates (in Plexdata.Utilities.Templates.dll) Version: 1.0.0

Syntax

C#

public class Options

The Options type exposes the following members.

Constructors

 

Name Description
Private methodStatic member Options Default static construction.
Public method Options Default construction.
  Back to Top

Properties

 

Name Description
Public property Fallback Gets and sets the rendering fallback value.
Public property IsFallback Indicates if fallback value should be used instead of rendering the original token descriptor.
Public property IsLimited Indicates if string formatting should be treated as limited.
Public propertyCode example Maximum Gets and sets the maximum length of the formatted result string.
Public property Provider Gets and sets the format provider to be used.
Public property Serializer Gets and sets the instance of a serializer used to process custom types.
  Back to Top

Methods

 

Name Description
Protected methodStatic member Create Creates a new options instance and applies provided parameters.
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
  Back to Top

Fields

 

Name Description
Public fieldStatic member Default Gets the default options instance.
  Back to Top

Extension Methods

 

Name Description
Private Extension Method CanExpand Determines whether the argument can be expanded. (Defined by ArgumentExtension.)
Public Extension Method IsSystemType Determines whether an argument is of a build-in system type. (Defined by ArgumentExtension.)
  Back to Top

Remarks

This options class allows users to configure the template formatter and its behaviour.

See Also

Reference

Plexdata.Utilities.Formatting Namespace
Template.Truncate(Options, StringBuilder)
Template.Format(Options, String, Object[])

⚠️ **GitHub.com Fallback** ⚠️