Class RepositoryItemDescriptor

Namespace

combit.Reporting.Repository

Assembly

combit.ListLabel31.CrossPlatform.dll

Provides access to the descriptors of repository items.

public class RepositoryItemDescriptor : IDisposable

Inheritance

object

RepositoryItemDescriptor

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Type

Gets the repository item type from the descriptor. See Type.

public string Type { get; }

Property Value

string

Methods

ClearUINames()

Resets the language-specific display names of the repository item.

public void ClearUINames()

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

Dispose(bool)

protected virtual void Dispose(bool disposing)

Parameters

disposing bool

GetFolderId()

Returns the folder id of the file (if any).

public string GetFolderId()

Returns

string

GetParentId()

Returns the repository id of the parent (if any). Allows, e.g., to find the project that belongs to a printer definition or sketch item in the repository.

public string GetParentId()

Returns

string

GetUIName(int)

See SetUIName(int, string).

public string GetUIName(int lcid)

Parameters

lcid int

LCID of the language to get.

Returns

string

LoadFromDescriptorString(string)

Reads the descriptor that was provided for a repository item in CreateOrUpdateItem(RepositoryItem, string?, Stream?).

public static RepositoryItemDescriptor LoadFromDescriptorString(string descriptor)

Parameters

descriptor string

A repository item's descriptor (see Descriptor).

Returns

RepositoryItemDescriptor

SerializeToString()

Converts the modified repository item descriptor back to a string that may be used when registering the available repository items.

public string SerializeToString()

Returns

string

SetFolderId(string)

Sets the folder id of the file.

public void SetFolderId(string id)

Parameters

id string

SetUIName(int, string)

Sets a custom display name of a repository item for the specified language.

public void SetUIName(int lcid, string name)

Parameters

lcid int

LCID of the language to set.

name string

Display name to set for the specified language.

SyncItemFromRepository(RepositoryItem, bool)

Fetches the UI name of the current repository item and stores it in the model.

public static void SyncItemFromRepository(RepositoryItem repo, bool forceSync = false)

Parameters

repo RepositoryItem

forceSync bool

Forces syncing the repository item in case its properties are already populated.