Class RepositoryItemDescriptorCrossPlatformObject

Namespace

combit.Reporting.Repository

Assembly

combit.ListLabel31.CrossPlatform.dll

Represents a cross-platform repository item descriptor object. Provides support for item type, folder/parent identifiers, and localized names/descriptions.

public class RepositoryItemDescriptorCrossPlatformObject

Inheritance

object

RepositoryItemDescriptorCrossPlatformObject

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

RepositoryItemDescriptorCrossPlatformObject()

public RepositoryItemDescriptorCrossPlatformObject()

RepositoryItemDescriptorCrossPlatformObject(string, string, string, DateTime?)

Initializes a new instance of RepositoryItemDescriptorCrossPlatformObject with optional metadata.

public RepositoryItemDescriptorCrossPlatformObject(string type, string folderId = null, string parentId = null, DateTime? lastModified = null)

Parameters

type string

The repository item type (e.g., "List", "Label").

folderId string

Optional folder Id.

parentId string

Optional parent Id.

lastModified DateTime?

Optional last modified date. Defaults to current UTC time if not provided.

Properties

Descriptions

public Dictionary<int, string> Descriptions { get; }

Property Value

Dictionary<int, string>

FolderId

public string FolderId { get; set; }

Property Value

string

LastModified

public DateTime LastModified { get; set; }

Property Value

DateTime

ParentId

public string ParentId { get; set; }

Property Value

string

Type

public string Type { get; set; }

Property Value

string

UINames

public Dictionary<int, string> UINames { get; }

Property Value

Dictionary<int, string>

Methods

ClearUINames()

Removes all localized display names.

public void ClearUINames()

DeserializeFromJson(string)

Deserializes a JSON string into a RepositoryItemDescriptorCrossPlatformObject.

public static RepositoryItemDescriptorCrossPlatformObject DeserializeFromJson(string json)

Parameters

json string

The serialized JSON string.

Returns

RepositoryItemDescriptorCrossPlatformObject

The deserialized descriptor object.

Exceptions

ListLabelException

Thrown if deserialization fails.

GetDescription(int)

Gets the localized description for the given locale ID.

public string GetDescription(int lcid = 0)

Parameters

lcid int

The locale ID. Defaults to 0 (neutral).

Returns

string

The description string, or null if not set.

GetUIName(int)

Gets the localized display name for the given locale ID.

public string GetUIName(int lcid = 0)

Parameters

lcid int

The locale ID. Defaults to 0 (neutral).

Returns

string

The display name for the locale, or null if not set.

SerializeToJson()

Serializes this descriptor object to a JSON string.

public string SerializeToJson()

Returns

string

A JSON-formatted string representing the descriptor.

SetDescription(int, string)

Sets or removes a localized description for the specified locale ID.

public void SetDescription(int lcid, string description)

Parameters

lcid int

The locale ID.

description string

The description string. If null, the entry is removed.

SetUIName(int, string)

Sets or removes a localized display name for the specified locale ID.

public void SetUIName(int lcid, string name)

Parameters

lcid int

The locale ID.

name string

The name to assign. If null, the entry is removed.