Class VisibleForListProvider

List provider for the VisibleFor dropdown control. Items are of type associate, usergroup or all, with a separate id space for each type. The current associate, its primary and secondary groups, and 'all' are the returned elements. MDO list sorting preferences for the UserGroup list are respected.

Inheritance
object
LiteralsOnlyBase
VisibleForListProvider
Inherited Members
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.dll
Syntax
[MDOProviderPlugin("VisibleFor")]
[MDOAdditionalInfo("Comma separated list of associate ids", "123,234,34")]
public class VisibleForListProvider : LiteralsOnlyBase, ISoListProvider, ISoList
Remarks

Associate items have positive ID's equal to the associate id, group items have negative id's equal to -usergroup id, and the All item has the id value int.MinValue.

You can pass in an associate ID in the additionalInfo parameter, this will return a VisibleFor list customized to that associate's view of the world. If additionalInfo is blank, not a number, or 0, the current associate is used.

You can also pass in a list of associate ids, as a string with space/comma delimiters. Example: '1, 2, 45, 999,12'. In this case, you will get a VisibleFor populated with the All choice, plus the intersection of all the groups of all the associates. I.e., something set as Visible For one of these choices will be visible to all these associates.

Constructors

VisibleForListProvider()

List provider for the VisibleFor dropdown control. Items are of type associate, usergroup or all, with a separate id space for each type. The current associate, its primary and secondary groups, and 'all' are the returned elements. MDO list sorting preferences for the UserGroup list are respected.

Declaration
public VisibleForListProvider()
Remarks

Associate items have positive ID's equal to the associate id, group items have negative id's equal to -usergroup id, and the All item has the id value int.MinValue.

You can pass in an associate ID in the additionalInfo parameter, this will return a VisibleFor list customized to that associate's view of the world. If additionalInfo is blank, not a number, or 0, the current associate is used.

You can also pass in a list of associate ids, as a string with space/comma delimiters. Example: '1, 2, 45, 999,12'. In this case, you will get a VisibleFor populated with the All choice, plus the intersection of all the groups of all the associates. I.e., something set as Visible For one of these choices will be visible to all these associates.

Fields

ProviderName

List provider for the VisibleFor dropdown control. Items are of type associate, usergroup or all, with a separate id space for each type. The current associate, its primary and secondary groups, and 'all' are the returned elements. MDO list sorting preferences for the UserGroup list are respected.

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

Associate items have positive ID's equal to the associate id, group items have negative id's equal to -usergroup id, and the All item has the id value int.MinValue.

You can pass in an associate ID in the additionalInfo parameter, this will return a VisibleFor list customized to that associate's view of the world. If additionalInfo is blank, not a number, or 0, the current associate is used.

You can also pass in a list of associate ids, as a string with space/comma delimiters. Example: '1, 2, 45, 999,12'. In this case, you will get a VisibleFor populated with the All choice, plus the intersection of all the groups of all the associates. I.e., something set as Visible For one of these choices will be visible to all these associates.

Methods

AddItems()

Construct the list; see the class description for its content

Declaration
protected override void AddItems()
Overrides
Remarks

Associate items have positive ID's equal to the associate id, group items have negative id's equal to -usergroup id, and the All item has the id value int.MinValue.

You can pass in an associate ID in the additionalInfo parameter, this will return a VisibleFor list customized to that associate's view of the world. If additionalInfo is blank, not a number, or 0, the current associate is used.

You can also pass in a list of associate ids, as a string with space/comma delimiters. Example: '1, 2, 45, 999,12'. In this case, you will get a VisibleFor populated with the All choice, plus the intersection of all the groups of all the associates. I.e., something set as Visible For one of these choices will be visible to all these associates.

Implements

Extension Methods