public class ResultListFormat : Definition| Comment |
Internal documentation comments. All text is ignored by the system.
(Inherited from Definition) |
| CommonName |
A human readable short name for this Definition. If no specific value
is given, then the ProperName portion of the SetName is returned instead.
(Inherited from Definition) |
| Deprecated |
If true, the major version of this Definition will be marked Discontinued in the future.
The author should put in .Comments additional information on when it will be deprecated. (Inherited from SparseDefinition) |
| Description |
A human readable description of this Definition. May be verbose.
(Inherited from Definition) |
| Discipline |
The high level shooting discipline that uses this Definition.
(Inherited from Definition) |
| Discontinued |
If true, the major version of this Definition is no longer in use and should not be referenced. Other major versions
of this same Definition may still be in use (e.g. v1.0 vs v2.0).
(Inherited from SparseDefinition) |
| Fields | A list of ResultListFields that define field values that will be used in the text output of the Result List Intermediate Fromat cell values. |
| Format | Describes the intermediate format for cells of data within a Result List. |
| HierarchicalName |
HierarchicalName is namespace:properName
(Inherited from Definition) |
| JSONVersion |
The Version string of the JSON document.
(Inherited from Definition) |
| ModifiedAt |
The date and time this definition version was uploaded to the Rest API.
(Inherited from SparseDefinition) |
| Owner |
The Orion license account number of who owns, and is responsible for, this desciption.
There is often a one to one relationship between the Owner and namespace of a Definition.
(Inherited from Definition) |
| ScoreConfigDefault | The name of the ScoreConfig to use if none other is specified. |
| ScoreFormatCollectionDef | String, formated as a set name. The set name of the ScoreFormatCollection to use when formatting score results. the default value is v1.0:orion:Standard Score Formats. |
| SetName |
A SetName is a unique identifier for a Defintion file within a definition type. It has three parts, the version number, namespace, and propername.
(Inherited from SparseDefinition) |
| SpecificationMessages | (Inherited from Definition) |
| Subdiscipline |
The subdiscipline (under the value of Discipline) to categorize this Definition.
The value of a "Subdiscipline" field may be any text string. However, there is a list of common subdisciplines and tags that should be used as appropriate.
(Inherited from Definition) |
| Tags |
The tag or tags to categorize this Definition with.
The value of a "Tags" field may be any text string. However, there is a list of common subdisciplines and tags that should be used as appropriate.
(Inherited from Definition) |
| Type |
The Definition Type
(Inherited from SparseDefinition) |
| Version |
The precise version number of this Definition. Note, the version number listed in the SetName is often
a reference to either the latest Major release. Version always provides both the Major and Minor release numbers and is not a reference.
(Inherited from SparseDefinition) |
| ConvertValues |
Method to set default values on a new Definition. Implementation specific for each definition type.
(Overrides DefinitionConvertValues) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetDefinitionVersion |
Returns the Version of the Definition as an object DefinitionVersion.
the string varation is returned with the property .Version
(Inherited from SparseDefinition) |
| GetFieldNames | Helper method, that returns a list of FieldNames that are acceptable for string interpolation in Display.Columns. This list includes both the standard FieldNames (e.g. DisplayName) as well of the FieldNames defined by the user in .Fields |
| GetFileName |
Returns the file name for this Definition. It should be stored in a directory named after the definition type.
(Inherited from Definition) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetHierarchicalName |
Returns the value of .HierarchicalName as an HierarchicalName object.
(Inherited from Definition) |
| GetMeetsSpecificationAsync | (Overrides DefinitionGetMeetsSpecificationAsync) |
| GetRelativePath |
Definitions, by commonality, are saved to file system in a standard relative directory structure. This method
returns that standard relative path.
(Inherited from Definition) |
| GetScoreFormatCollectionDefinitionAsync | |
| GetSetName |
Returns a SetName object based on the Definitions Version and HierrchcialName
If originalSetName is true, returns the setname as was loaded, usually with v1.0, or v0.0
If false, returns the Version based on the version in the file
(Inherited from Definition) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| IsVersionUpdateAvaliableAsync |
Checks to see if there is a newer minor version of the Definition file avaliable through the Rest API
(Inherited from Definition) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| SaveToFile(DirectoryInfo) |
Helper method to save the Definition file to local storage.
Will save the definition file under [definitionDirectory]/DEFINITIONS/[Definition Type]/[SetName].json (Inherited from Definition) |
| SaveToFile(FileInfo) |
Helper method to save the Definition to file
(Inherited from Definition) |
| SerializeToJson |
Returns this Definition as a json serialized string.
(Inherited from Definition) |
| SetDefaultValues | (Overrides DefinitionSetDefaultValues) |
| ToString | Returns a string that represents the current object. (Inherited from SparseDefinition) |