Interface IFavoritesStructureItem
Элемент структуры избранного.
Inherited Members
Namespace: Ascon.Polynom.Api
Assembly: Ascon.Polynom.Api.dll
Syntax
public interface IFavoritesStructureItem : IBaseGroupOwner, IApiObject, IApiEntity, INotifyPropertyChanged
Properties
BelongsToCurrentUser
Возвращает признак принадлежит ли элемент текущему пользователю.
Declaration
bool BelongsToCurrentUser { get; }
Property Value
| Type | Description |
|---|---|
| bool |
Favorites
Избранные объекты в текущем элементе структуры избранного.
Declaration
IApiReadOnlyCollection<IAbleToBeFavorite> Favorites { get; }
Property Value
| Type | Description |
|---|---|
| IApiReadOnlyCollection<IAbleToBeFavorite> |
FavoritesGroups
Возвращает коллекцию дочерних групп.
Declaration
IApiReadOnlyCollection<IFavoritesGroup> FavoritesGroups { get; }
Property Value
| Type | Description |
|---|---|
| IApiReadOnlyCollection<IFavoritesGroup> |
Methods
AddFavorite(IAbleToBeFavorite)
Добавляет сущность в текущий элемент структуры избранного.
Declaration
bool AddFavorite(IAbleToBeFavorite ableToBeFavorite)
Parameters
| Type | Name | Description |
|---|---|---|
| IAbleToBeFavorite | ableToBeFavorite | Сущность, способная быть в избранном. |
Returns
| Type | Description |
|---|---|
| bool | Признак, удалось ли добавить сущность. |
CreateFavoritesGroup(string, Guid?)
Создает группу.
Declaration
IFavoritesGroup CreateFavoritesGroup(string name, Guid? id = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Имя группы. |
| Guid? | id | Уникальный идентификатор. |
Returns
| Type | Description |
|---|---|
| IFavoritesGroup | Созданная группа. |
IsThereFavoriteHereOrBelow(IAbleToBeFavorite)
Возвращает признак, есть ли в этом элементе структуры избранного или в структуре избранного ниже сущность, способная быть в избранном.
Declaration
bool IsThereFavoriteHereOrBelow(IAbleToBeFavorite ableToBeFavorite)
Parameters
| Type | Name | Description |
|---|---|---|
| IAbleToBeFavorite | ableToBeFavorite | Сущность, способная быть в избранном. |
Returns
| Type | Description |
|---|---|
| bool | Признак, есть ли в этом элементе структуры избранного или в структуре избранного ниже сущность, способная быть в избранном. |
RemoveFavorite(IAbleToBeFavorite)
Удаляет сущность из текущего элемента структуры избранного.
Declaration
bool RemoveFavorite(IAbleToBeFavorite ableToBeFavorite)
Parameters
| Type | Name | Description |
|---|---|---|
| IAbleToBeFavorite | ableToBeFavorite | Сущность, способная быть в избранном. |
Returns
| Type | Description |
|---|---|
| bool | Признак, удалось ли удалить сущность. |
RemoveFavoriteHereOrBelow(IAbleToBeFavorite)
Исключает сущность, способную быть в избранном, из текущего элемента структуры избранного или из структуры избранного ниже.
Declaration
bool RemoveFavoriteHereOrBelow(IAbleToBeFavorite ableToBeFavorite)
Parameters
| Type | Name | Description |
|---|---|---|
| IAbleToBeFavorite | ableToBeFavorite | Сущность, способная быть в избранном. |
Returns
| Type | Description |
|---|---|
| bool | Признак, была ли сущность исключена. |