Show / Hide Table of Contents

Class TimeZoneProvider

Provides the timezone list. If no search value is passed in the list is restricted to 'available' timezones

Inheritance
object
TimeZoneProvider
TimeZoneIANAProvider
TimeZoneWithCodeProvider
Implements
ISoListProvider
ISoList
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.dll
Syntax
[MDOProviderPlugin("TimeZone")]
[MDOAdditionalInfo("Get all timezones", "[all]")]
[MDOAdditionalInfo("Get all active timezones and the given location", 1234)]
[MDOAdditionalInfo("locationId", "Get the specific Timezone location", 1234)]
public class TimeZoneProvider : ISoListProvider, ISoList
Remarks

AdditionalInfo = "[all]" returns all timezones

AdditionalInfo = "123" returns all active timezones and the specific location

AdditionalInfo = "locationId=123" returns only the given location.

/// AdditionalInfo = "countryFlag=true" returns an iconhint for the country's flag.

Constructors

TimeZoneProvider()

Provides the timezone list. If no search value is passed in the list is restricted to 'available' timezones

Declaration
public TimeZoneProvider()
Remarks

AdditionalInfo = "[all]" returns all timezones

AdditionalInfo = "123" returns all active timezones and the specific location

AdditionalInfo = "locationId=123" returns only the given location.

/// AdditionalInfo = "countryFlag=true" returns an iconhint for the country's flag.

Fields

ProviderName

Provides the timezone list. If no search value is passed in the list is restricted to 'available' timezones

Declaration
public const string ProviderName = "TimeZone"
Field Value
Type Description
string
Remarks

AdditionalInfo = "[all]" returns all timezones

AdditionalInfo = "123" returns all active timezones and the specific location

AdditionalInfo = "locationId=123" returns only the given location.

/// AdditionalInfo = "countryFlag=true" returns an iconhint for the country's flag.

_TZDstRuleTableInfo

Provides the timezone list. If no search value is passed in the list is restricted to 'available' timezones

Declaration
protected TZDstRuleTableInfo _TZDstRuleTableInfo
Field Value
Type Description
TZDstRuleTableInfo
Remarks

AdditionalInfo = "[all]" returns all timezones

AdditionalInfo = "123" returns all active timezones and the specific location

AdditionalInfo = "locationId=123" returns only the given location.

/// AdditionalInfo = "countryFlag=true" returns an iconhint for the country's flag.

_TZLocationTableInfo

Provides the timezone list. If no search value is passed in the list is restricted to 'available' timezones

Declaration
protected TZLocationTableInfo _TZLocationTableInfo
Field Value
Type Description
TZLocationTableInfo
Remarks

AdditionalInfo = "[all]" returns all timezones

AdditionalInfo = "123" returns all active timezones and the specific location

AdditionalInfo = "locationId=123" returns only the given location.

/// AdditionalInfo = "countryFlag=true" returns an iconhint for the country's flag.

_TZStdRuleTableInfo

Provides the timezone list. If no search value is passed in the list is restricted to 'available' timezones

Declaration
protected TZStdRuleTableInfo _TZStdRuleTableInfo
Field Value
Type Description
TZStdRuleTableInfo
Remarks

AdditionalInfo = "[all]" returns all timezones

AdditionalInfo = "123" returns all active timezones and the specific location

AdditionalInfo = "locationId=123" returns only the given location.

/// AdditionalInfo = "countryFlag=true" returns an iconhint for the country's flag.

_additionalInfo

Provides the timezone list. If no search value is passed in the list is restricted to 'available' timezones

Declaration
protected string _additionalInfo
Field Value
Type Description
string
Remarks

AdditionalInfo = "[all]" returns all timezones

AdditionalInfo = "123" returns all active timezones and the specific location

AdditionalInfo = "locationId=123" returns only the given location.

/// AdditionalInfo = "countryFlag=true" returns an iconhint for the country's flag.

_countryTableInfo

Provides the timezone list. If no search value is passed in the list is restricted to 'available' timezones

Declaration
protected CountryTableInfo _countryTableInfo
Field Value
Type Description
CountryTableInfo
Remarks

AdditionalInfo = "[all]" returns all timezones

AdditionalInfo = "123" returns all active timezones and the specific location

AdditionalInfo = "locationId=123" returns only the given location.

/// AdditionalInfo = "countryFlag=true" returns an iconhint for the country's flag.

_forceFlatList

Provides the timezone list. If no search value is passed in the list is restricted to 'available' timezones

Declaration
protected bool _forceFlatList
Field Value
Type Description
bool
Remarks

AdditionalInfo = "[all]" returns all timezones

AdditionalInfo = "123" returns all active timezones and the specific location

AdditionalInfo = "locationId=123" returns only the given location.

/// AdditionalInfo = "countryFlag=true" returns an iconhint for the country's flag.

_homeItem

Provides the timezone list. If no search value is passed in the list is restricted to 'available' timezones

Declaration
protected SoListItem _homeItem
Field Value
Type Description
SoListItem
Remarks

AdditionalInfo = "[all]" returns all timezones

AdditionalInfo = "123" returns all active timezones and the specific location

AdditionalInfo = "locationId=123" returns only the given location.

/// AdditionalInfo = "countryFlag=true" returns an iconhint for the country's flag.

_searchValue

Provides the timezone list. If no search value is passed in the list is restricted to 'available' timezones

Declaration
protected string _searchValue
Field Value
Type Description
string
Remarks

AdditionalInfo = "[all]" returns all timezones

AdditionalInfo = "123" returns all active timezones and the specific location

AdditionalInfo = "locationId=123" returns only the given location.

/// AdditionalInfo = "countryFlag=true" returns an iconhint for the country's flag.

Methods

AddItems(bool)

Add all the items

Declaration
protected virtual void AddItems(bool onlyReadHistory)
Parameters
Type Name Description
bool onlyReadHistory
Remarks

AdditionalInfo = "[all]" returns all timezones

AdditionalInfo = "123" returns all active timezones and the specific location

AdditionalInfo = "locationId=123" returns only the given location.

/// AdditionalInfo = "countryFlag=true" returns an iconhint for the country's flag.

BaseQuery()

Provides the timezone list. If no search value is passed in the list is restricted to 'available' timezones

Declaration
protected virtual Select BaseQuery()
Returns
Type Description
Select
Remarks

AdditionalInfo = "[all]" returns all timezones

AdditionalInfo = "123" returns all active timezones and the specific location

AdditionalInfo = "locationId=123" returns only the given location.

/// AdditionalInfo = "countryFlag=true" returns an iconhint for the country's flag.

ClearHistoryItems()

Clears the history items

Declaration
public void ClearHistoryItems()
Remarks

AdditionalInfo = "[all]" returns all timezones

AdditionalInfo = "123" returns all active timezones and the specific location

AdditionalInfo = "locationId=123" returns only the given location.

/// AdditionalInfo = "countryFlag=true" returns an iconhint for the country's flag.

GenerateName(string, double)

Generates a string in this format: Norway(GMT+01.00)

Declaration
public static string GenerateName(string name, double bias)
Parameters
Type Name Description
string name
double bias
Returns
Type Description
string
Remarks

AdditionalInfo = "[all]" returns all timezones

AdditionalInfo = "123" returns all active timezones and the specific location

AdditionalInfo = "locationId=123" returns only the given location.

/// AdditionalInfo = "countryFlag=true" returns an iconhint for the country's flag.

GenerateOffsetString(double, string)

Provides the timezone list. If no search value is passed in the list is restricted to 'available' timezones

Declaration
public static string GenerateOffsetString(double displayBias, string separator)
Parameters
Type Name Description
double displayBias
string separator
Returns
Type Description
string
Remarks

AdditionalInfo = "[all]" returns all timezones

AdditionalInfo = "123" returns all active timezones and the specific location

AdditionalInfo = "locationId=123" returns only the given location.

/// AdditionalInfo = "countryFlag=true" returns an iconhint for the country's flag.

GetCountryHeader(string, SoListItem, out SoListHeading)

Provides the timezone list. If no search value is passed in the list is restricted to 'available' timezones

Declaration
protected bool GetCountryHeader(string countryName, SoListItem item, out SoListHeading heading)
Parameters
Type Name Description
string countryName

Name og heading(country)

SoListItem item

ExtraInfo of this item decides which header to return

SoListHeading heading

Heading item returned

Returns
Type Description
bool

Returns true if a heading is created otherwise false

Remarks

AdditionalInfo = "[all]" returns all timezones

AdditionalInfo = "123" returns all active timezones and the specific location

AdditionalInfo = "locationId=123" returns only the given location.

/// AdditionalInfo = "countryFlag=true" returns an iconhint for the country's flag.

GetHeadingItemsAsync(CancellationToken)

list of headings

Declaration
public Task<List<ISoListHeading>> GetHeadingItemsAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<List<ISoListHeading>>
Remarks

AdditionalInfo = "[all]" returns all timezones

AdditionalInfo = "123" returns all active timezones and the specific location

AdditionalInfo = "locationId=123" returns only the given location.

/// AdditionalInfo = "countryFlag=true" returns an iconhint for the country's flag.

GetHistoryItemsAsync(CancellationToken)

list of history items

Declaration
public Task<List<ISoListItem>> GetHistoryItemsAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<List<ISoListItem>>
Remarks

AdditionalInfo = "[all]" returns all timezones

AdditionalInfo = "123" returns all active timezones and the specific location

AdditionalInfo = "locationId=123" returns only the given location.

/// AdditionalInfo = "countryFlag=true" returns an iconhint for the country's flag.

GetRootItemsAsync(CancellationToken)

list of root-level items (items not under any heading)

Declaration
public Task<List<ISoListItem>> GetRootItemsAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<List<ISoListItem>>
Remarks

AdditionalInfo = "[all]" returns all timezones

AdditionalInfo = "123" returns all active timezones and the specific location

AdditionalInfo = "locationId=123" returns only the given location.

/// AdditionalInfo = "countryFlag=true" returns an iconhint for the country's flag.

IsSameCountry(SoListItem, SoListItem)

Provides the timezone list. If no search value is passed in the list is restricted to 'available' timezones

Declaration
protected virtual bool IsSameCountry(SoListItem itemA, SoListItem itemB)
Parameters
Type Name Description
SoListItem itemA
SoListItem itemB
Returns
Type Description
bool
Remarks

AdditionalInfo = "[all]" returns all timezones

AdditionalInfo = "123" returns all active timezones and the specific location

AdditionalInfo = "locationId=123" returns only the given location.

/// AdditionalInfo = "countryFlag=true" returns an iconhint for the country's flag.

OnBaseTimeItemCreated(SoListItem)

Provides the timezone list. If no search value is passed in the list is restricted to 'available' timezones

Declaration
protected virtual void OnBaseTimeItemCreated(SoListItem baseTimeItem)
Parameters
Type Name Description
SoListItem baseTimeItem
Remarks

AdditionalInfo = "[all]" returns all timezones

AdditionalInfo = "123" returns all active timezones and the specific location

AdditionalInfo = "locationId=123" returns only the given location.

/// AdditionalInfo = "countryFlag=true" returns an iconhint for the country's flag.

PopulateFromReader(List<ISoListItem>, SoDataReader, bool, bool, bool)

Provides the timezone list. If no search value is passed in the list is restricted to 'available' timezones

Declaration
protected virtual void PopulateFromReader(List<ISoListItem> items, SoDataReader reader, bool includeCountryName, bool isHistoryItem = false, bool useCodeAsType = false)
Parameters
Type Name Description
List<ISoListItem> items
SoDataReader reader
bool includeCountryName
bool isHistoryItem
bool useCodeAsType
Remarks

AdditionalInfo = "[all]" returns all timezones

AdditionalInfo = "123" returns all active timezones and the specific location

AdditionalInfo = "locationId=123" returns only the given location.

/// AdditionalInfo = "countryFlag=true" returns an iconhint for the country's flag.

Implements

ISoListProvider
ISoList

Extension Methods

EnumUtil.MapEnums<From, To>(From)
Converters.MapEnums<From, To>(From)
ObjectExtensions.AssignByReflection<T>(T, T)
ObjectExtensions.GraphCopy<T>(T)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top