public class ResultListIntermediateFormatted| ResultListIntermediateFormatted | Converts a list of ResultEvents, that is returned by the GetResultList API, to a list of ResultEventIntermediates. |
| DisplayPartitions | This ResultListDisplayPartitions to use is dependent on if the Result List is a team event. This is a helper property to return the correct ResultListDisplayPartitions. |
| Engagable |
Gets or sets the engagable variable. Which indicates if the Result List Format will be displayed
on a screen that supports human interaction, such as a desktop browser or mobile phone. A leaderboard
or MM100 would not support human interaction.
The default value is true. |
| FieldNames | Gets the list of FieldNames in use by this ResultListFormat |
| GetParticipantAttributeBankPtr | Overrides the method the ResultListIntermediateFormatted uses to calculate the Squadding field in each row. |
| GetParticipantAttributeClubPtr | Overrides the method the ResultListIntermediateFormatted uses to calculate the Club field in each row. |
| GetParticipantAttributeCompetitorNumberPtr | Overrides the method the ResultListIntermediateFormatted uses to calculate the CompetitorNumber field in each row. |
| GetParticipantAttributeCountryPtr | Overrides the method the ResultListIntermediateFormatted uses to calculate the Country field in each row. |
| GetParticipantAttributeCreatorPtr | Overrides the method the ResultListIntermediateFormatted uses to calculate the Creator field in each row. |
| GetParticipantAttributeDisplayNamePtr | Overrides the method the ResultListIntermediateFormatted uses to calculate the DisplayName field in each row. |
| GetParticipantAttributeDisplayNameShortPtr | Overrides the method the ResultListIntermediateFormatted uses to calculate the DisplayNameShort field in each row. |
| GetParticipantAttributeEmptyPtr | Overrides the method the ResultListIntermediateFormatted uses to calculate the Empty field in each row. |
| GetParticipantAttributeFamilyNamePtr | Overrides the method the ResultListIntermediateFormatted uses to calculate the FamilyName field in each row. |
| GetParticipantAttributeFiringOrderPtr | Overrides the method the ResultListIntermediateFormatted uses to calculate the Squadding field in each row. |
| GetParticipantAttributeFiringPointPtr | Overrides the method the ResultListIntermediateFormatted uses to calculate the Squadding field in each row. |
| GetParticipantAttributeGivenNamePtr | Overrides the method the ResultListIntermediateFormatted uses to calculate the GivenName field in each row. |
| GetParticipantAttributeHomeTownPtr | Overrides the method the ResultListIntermediateFormatted uses to calculate the HomeTown field in each row. |
| GetParticipantAttributeLastShotPtr | Overrides the method the ResultListIntermediateFormatted uses to calculate the LastShot field in each row. |
| GetParticipantAttributeLocalDatePtr | Overrides the method the ResultListIntermediateFormatted uses to calculate the LocalDate field in each row. |
| GetParticipantAttributeMatchIDPtr | Overrides the method the ResultListIntermediateFormatted uses to calculate the MatchID field in each row. |
| GetParticipantAttributeMatchLocationPtr | Overrides the method the ResultListIntermediateFormatted uses to calculate the MatchLocation field in each row. |
| GetParticipantAttributeMiddleNamePtr | Overrides the method the ResultListIntermediateFormatted uses to calculate the MiddleName field in each row. |
| GetParticipantAttributeOwnerPtr | Overrides the method the ResultListIntermediateFormatted uses to calculate the Owner field in each row. |
| GetParticipantAttributeRangePtr | Overrides the method the ResultListIntermediateFormatted uses to calculate the Squadding field in each row. |
| GetParticipantAttributeRankDeltaPtr | Overrides the method the ResultListIntermediateFormatted uses to calculate the RankDelta field in each row. |
| GetParticipantAttributeRankOrderPtr | Overrides the method the ResultListIntermediateFormatted uses to calculate the RankOrder field in each row. |
| GetParticipantAttributeRankOrSquaddingPtr | Overrides the method the ResultListIntermediateFormatted uses to calculate the RankOrSquadding field in each row. |
| GetParticipantAttributeRankPtr | Overrides the method the ResultListIntermediateFormatted uses to calculate the Rank field in each row. |
| GetParticipantAttributeReentryPtr | Overrides the method the ResultListIntermediateFormatted uses to calculate the Squadding field in each row. |
| GetParticipantAttributeRelayPtr | Overrides the method the ResultListIntermediateFormatted uses to calculate the Squadding field in each row. |
| GetParticipantAttributeRemarkPtr | Overrides the method the ResultListIntermediateFormatted uses to calculate the Remark field in each row. |
| GetParticipantAttributeResultCOFIDPtr | Overrides the method the ResultListIntermediateFormatted uses to calculate the ResultCOFID field in each row. |
| GetParticipantAttributeSquaddingPtr | Overrides the method the ResultListIntermediateFormatted uses to calculate the Squadding field in each row. |
| GetParticipantAttributeSquadPtr | Overrides the method the ResultListIntermediateFormatted uses to calculate the Squadding field in each row. |
| GetParticipantAttributeStatusPtr | Overrides the method the ResultListIntermediateFormatted uses to calculate the Status field in each row. |
| GetParticipantAttributeTargetCollectionNamePtr | Overrides the method the ResultListIntermediateFormatted uses to calculate the TargetCollectionName field in each row. |
| GetParticipantAttributeUserIDPtr | Overrides the method the ResultListIntermediateFormatted uses to calculate the UserID field in each row. |
| HasColumnsForWiderScreen | Returns a boolean, indicating if some columns are hidden because the ResolutionWidth is too small. |
| ResolutionWidth |
The width of the screen that this Result List Formatted will be displayeed on. Depending on the width
some columsn may, or may not, be displayed. The Result List Fromatted uses the same breakpoints as
Bootstrap 5.
The default value is int.MaxValue, which basically means a screen width of infinite width. Values of less than 0, are interpreted as being 0. |
| ResultList | |
| ResultListFormat | Gets the ResultListFormat definition in use in this display |
| RLIFList | Gets the Orion ResultList used in this translation. |
| Rows | Gets the list of all rows to display in the formatted results. This lists includes Rows hidden by row limiting properties. |
| ScoreFormatCollection | Gets the ScoreFormatCollection Definition used in this Result List |
| ShownRows | Gets the list of rows to display in the formatted results. This lists excludes Rows hidden by the row limited properties (listed below). |
| ShowNumberOfBodyRows |
Limits the number of body roes to show.
The default value is int.MaxValue, which means to show all body rows. This show parameter is over ruled by the ShowRanks parameter. |
| ShowNumberOfChildRows |
Limits the number of child rows to show under a main body row.
The default value is int.MaxValue, which means to show all children. Values of less than 0, are interpreted as being 0. |
| ShowRanks |
Gets or sets the number of highest ranked athletes or teams to always show,
regardless of othre row limiting properties, when .ShownRows is called.
For example, if ShowRanks is 3, then the athletes or teams ranked first, second, and third are always shown.
This property only effects parent rows, it does not effect child rows. The default value is 3. |
| ShowRelay |
Gets or sets the name of the relay to show. When set, only athletes on that relay will be shown.
Teams, who have one or more athltes on that relay will be shown, but only the team members on that
relay will be shown.
The default value is an empty string, which means to show all competitors from all relays. |
| ShowStatuses |
Gets or sets the set of ResultStatus (e.g. INTERMEDIATE, UNOFFICIAL) to show when .ShownRows is called.
When setting, if the HashSet is empty, then all ResultStatus will be included. |
| ShowSupplementalInformation |
Gets or sets the show supplemental information variable. What is or what is not supplemental information
is up to the composers of the RESULT LIST FORMAT to decide. Generally though its extra information
that is interesting, but not necessaryly required.
The default value is true. |
| ShowZeroScoresBeforeOFFICIAL |
Gets or sets a boolean indicating if scores with a zero score shold be displayed when the Result List status is FUTURE, INTERMEDIATE, or UNOFFICIAL
Scores that have a remark of DNS, DSQ, or DNF are still shown regardless of value.
The defautl value is true. |
| ShowZeroScoresWithOFFICIAL |
Gets or sets a boolean indicating if scores with a zero score shold be displayed when the Result LIst's staus is OFFICIAL.
Scores that have a remark of DNS, DSQ, or DNF are still shown regardless of value.
The defautl value is true. |
| UserProfileLookup | UserProfielDB instance to look up if a user id has a public profile. |
| AppendTokenizedResultList | When a Result List is tokenized (returned from the rest API in chuncks of 50), its common that ResultListIntermediateFormatted is initialize with only the first chunck of results. This function allows the user to append additional tokenized ResultList to this instance. It assumes the user is passing in the same ResultList, just with a different tokenized chunk of result list items. |
| Clear | Clears the existing Rows of this ResultListIntermediateFormatted. Likely becuase the Result List is going to be reloaded (using AppendTokenizedResultList). |
| 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) |
| GetColumnCount | Returns the total number of defined columns. Does not factor in hidden columns (from .HideColumnsWithTheseClasses). |
| GetColumnFooterCell | Returns the CellValue for one cell in the header row, specified by the columnIndex |
| GetColumnFooterValue | Returns the text value of the footer cell, specified by the columnIndex. Returns the same value as .GetColumnFooterCell( columnIndex ).Text |
| GetColumnHeaderCell | Returns the CellValue for one cell in the header row, specified by the columnIndex |
| GetColumnHeaderValue | Returns the text value of the header cell, specified by the columnIndex. Returns the same value as .GetColumnHeaderCell( columnIndex ).Text |
| GetFooterRow | Returns the entire header row, as a List of CellValues. |
| GetFooterRowClassList | |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetHeaderRow | Returns the entire header row, as a List of CellValues. |
| GetHeaderRowClassList | |
| GetRowAtRankOrder | Returns the ResultListIntermediateFormattedRow who has the rankOrder provided. If no row is found, null is returned. |
| GetScoreFormat | Returns the score format to use when displayg scores of type 'scoreFormatName'. Examples include Events => "{i} - {x}" or Shots => "{m}{d}{X}". If a score format could not be found, based on the passed in scoreFormatName, then the default value of "{d}" is returned. |
| GetShownColumnIndexes | Returns a list of columnIndex values, Each columnIndex is shown (e.g. not .Hide), as it will not contain a CSS Class that's listed in .HideColumnsWithTheseClasses. |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| InitializeAsync | Completes the constructor process, makes necessary Async calls that can not be done within the Constructor. |
| LoadSquaddingList |
When a ResultListIntermediateFormatted is instantiated with a ResultList, the ResultList object generally
does not include Squadding (the values of .Squadding are null). This method uses the passed in Squadding List to read
in squadding, setting the values of .Squadding.
Participants are matched up, between the ResultLIst and SquaddingList using their ResultCofId. |
| LoadSquaddingListAsync |
When a ResultListIntermediateFormatted is instantiated with a ResultList, the ResultList object generally
does not include Squadding (the values of .Squadding are null). This method uses GetSquaddingListPublic REST API call to read
in squadding, setting the values of .Squadding.
Participants are matched up, between the ResultLIst and SquaddingList using their ResultCofId. |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| RefreshAllRowsParticipantAttributeFields | Recalculates the standard participant attribute fields (e.g. rank, display name, club, etc). Is useful to call if the user overrode one of the GetParticipantAttribute Pointers |
| RefreshCacheAsync | |
| RefreshResultList | Updates the reference result list. Mostly used to refreshing the Result List's Meta Data. Does NOT effect the rows, ,use Clear() and AppendTokenizedResultList() to do this. |
| SetShowValuesToDefault |
Resets all "Show" values to their default. Specifially:
|
| ToString | Returns a string that represents the current object. (Inherited from Object) |