"preferencekey" MDO List

• 1 minute to read
 • 1 minute to read

MDO Provider that retrieves a list of preference keys corresponding to a given section

Preferences are described in the prefdesc table. This provider will retrieve descriptions for all keys grouped under a given section, passed in as the additionalInfo to the constructor.

Use the class to avoid (mis)coding preference section and key names as strings.

Each item contains the programmatic key name in the extraInfo field.

Implemented by the PreferenceKeyProvider class. The name of the MDO list is 'preferencekey'.

Additional Attributes

Description Name Example Value
Preference section name, optionally followed by ;excludesystemwide to exclude preferences that belong in the System Settings gui Functions

Sample Request

GET /api/v1/MDOList/preferencekey
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: *

Sample Code

var listProvider = SuperOffice.CRM.Lists.SoListProviderFactory.Create("preferencekey", forceFlatList: true);
foreach (var item in listProvider.RootItems) {
    Console.WriteLine("{0} {1} {2} {3}", 
         item.Id, ResourceManager.ParseInlineResources(item.Name), item.StyleHint, item.ExtraInfo);
}

Sample Output

Id Name StyleHint ExtraInfo
2 Example
  • "preferencekeyheadings"
  • "preferencekeyheadingswithallitem"
  • "preferencekeyheadingswithallitemwithnoselection"
  • "preferencekeyheadingswithnoselection"
  • "preferencekeywithallitem"
  • "preferencekeywithallitemwithnoselection"
  • "preferencekeywithnoselection"