Class BaseCodeReference

Namespace

Ecng.Compilation

Assembly

Ecng.Compilation.dll

Provides a base implementation for a code reference with persistence support.

public abstract class BaseCodeReference : ICodeReference, IPersistable

Inheritance

object

BaseCodeReference

Implements

ICodeReference

IPersistable

Derived

AssemblyReference

NuGetReference

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

AsyncHelper.FromResult<TValue>(TValue)

AsyncHelper.ToCompleteSource<TValue>(TValue)

CompareHelper.IsDefault<T>(T)

CompareHelper.IsRuntimeDefault<T>(T)

Converter.TypedTo<TFrom, TTo>(TFrom)

DelegateHelper.AddDelegate<TDelegate>(TDelegate, TDelegate)

DelegateHelper.GetInvocationList<TDelegate>(TDelegate)

DelegateHelper.RemoveAllDelegates<TDelegate>(TDelegate)

DelegateHelper.RemoveDelegate<TDelegate>(TDelegate, TDelegate)

DisposableHelper.MakeDisposable<T>(T, Action<T>)

Enumerator.IsDefined<T>(T)

Enumerator.SplitMask<T>(T)

NullableHelper.Convert<T, TResult>(T, Func<T, TResult>, Func<TResult>)

NullableHelper.IsNull<T>(T)

NullableHelper.IsNull<T>(T, bool)

TupleHelper.ToValues<T>(T)

TypeHelper.CheckOnNull<T>(T, string)

TypeHelper.DoDispose<TSource>(TSource)

TypeHelper.ToScope<T>(T, bool)

NetworkHelper.Format<T>(T, bool)

PersistableHelper.TrySerialize<T>(T, out SettingsStorage)

XamlHelper.CopyToClipboard<T>(T)

Paths.SerializeToString<T>(T, bool)

Paths.Serialize<T>(T, bool)

Paths.Serialize<T>(T, string, bool)

CompareHelper.Compare(object, object)

Converter.To(object, Type)

Converter.To<T>(object)

Enumerator.GetAttributeOfType<TAttribute>(object)

Enumerator.IsEnumBrowsable(object)

Enumerator.SplitMask2(object)

TypeHelper.HasProperty(object, string)

EntityPropertyHelper.GetPropValue(object, string, Func<object, string, object>, IDictionary<string, object>)

Extensions.GetBasicProperties(object, int)

Extensions.GetDisplayName(object)

Extensions.GetFieldDescription(object)

Extensions.GetFieldDisplayName(object)

Extensions.GetFieldIcon(object)

JsonHelper.ToJson(object, bool)

JsonHelper.ToJson(object, bool, JsonSerializerSettings)

PersistableHelper.ToStorage(object, bool)

EditorExtensions.ToItemsSource(object, Type, bool?, ListSortDirection?, Func<IItemsSourceItem, bool>, Func<object, string>, Func<object, string>)

XamlHelper.EnsureUIThread(object)

XamlHelper.ShowModel<TWindow>(object, DependencyObject)

XamlHelper.WpfCast<T>(object)

VirtualPropertyRegistry.TryGetVirtualValue(object, string, out object)

Constructors

BaseCodeReference()

protected BaseCodeReference()

Properties

Id

Gets the identifier of the code reference. Defaults to the location.

public virtual string Id { get; }

Property Value

string

IsValid

Gets a value indicating whether the code reference is valid.

public abstract bool IsValid { get; }

Property Value

bool

Location

Gets the location of the code reference.

public abstract string Location { get; }

Property Value

string

Name

Gets the name of the code reference.

public abstract string Name { get; }

Property Value

string

Methods

GetImages(CancellationToken)

Asynchronously retrieves the images associated with the code reference.

public abstract ValueTask<IEnumerable<(string name, byte[] body)>> GetImages(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

The token to monitor for cancellation requests.

Returns

ValueTask<IEnumerable<(string name, byte[] body)>>

A task that represents the asynchronous operation. The task result contains an enumerable of tuples with image name and image body.

Load(SettingsStorage)

Loads the settings from the specified storage.

public abstract void Load(SettingsStorage storage)

Parameters

storage SettingsStorage

The storage containing the settings.

Save(SettingsStorage)

Saves the settings to the specified storage.

public abstract void Save(SettingsStorage storage)

Parameters

storage SettingsStorage

The storage where the settings will be saved.

ToString()

Returns a string that represents the current code reference.

public override string ToString()

Returns

string

The location of the code reference.