Interface IFileTypeCustomMetadata

Namespace

PaintDotNet.FileTypes

Assembly

PaintDotNet.FileTypes.dll

Provides read/write access to custom metadata.

public interface IFileTypeCustomMetadata : IFileTypeMetadataSection, IReadOnlyFileTypeCustomMetadata, IReadOnlyFileTypeMetadataSection, IObjectRef, IIsDisposed, IDisposable, ICloneable, IReadOnlyFileTypePropertyBag, IInternalImpl, IReadOnlyDictionary<string, string>, IReadOnlyCollection<KeyValuePair<string, string>>, IEnumerable<KeyValuePair<string, string>>, IEnumerable

Inherited Members

IReadOnlyFileTypeCustomMetadata.Clone()

IReadOnlyFileTypeMetadataSection.Kind

IObjectRef.TryCreateRef(Type, out IObjectRef)

IIsDisposed.IsDisposed

IDisposable.Dispose()

IReadOnlyDictionary<string, string>.ContainsKey(string)

IReadOnlyDictionary<string, string>.TryGetValue(string, out string)

IReadOnlyDictionary<string, string>.this[string]

IReadOnlyDictionary<string, string>.Keys

IReadOnlyDictionary<string, string>.Values

IReadOnlyCollection<KeyValuePair<string, string>>.Count

IEnumerable<KeyValuePair<string, string>>.GetEnumerator()

IEnumerable.GetEnumerator()

Extension Methods

FileTypesObjectRefExtensions.CreateRef(IFileTypeCustomMetadata)

FileTypesObjectRefExtensions.CreateRef(IFileTypeMetadataSection)

FileTypesObjectRefExtensions.CreateRef(IReadOnlyFileTypeCustomMetadata)

FileTypesObjectRefExtensions.CreateRef(IReadOnlyFileTypeMetadataSection)

ReadOnlyFileTypePropertyBagEnumExtensions.GetValue<TEnum>(IReadOnlyFileTypePropertyBag, string, TEnum)

ReadOnlyFileTypePropertyBagEnumExtensions.TryGetValue<TEnum>(IReadOnlyFileTypePropertyBag, string, out TEnum)

ReadOnlyFileTypePropertyBagExtensions.GetValue<T>(IReadOnlyFileTypePropertyBag, string, in T)

ReadOnlyFileTypePropertyBagExtensions.TryGetValue<T>(IReadOnlyFileTypePropertyBag, string, out T)

Remarks

Custom or non-standard metadata is generally used by a FileType plugin to store private information that is not understood by other plugins or external systems.

Custom metadata will not be preserved when saving to standard file types such as PNG or JPEG, but will always be preserved when saving with Paint.NET's native .PDN format. It is up to each FileType plugin as to whether it will preserve custom metadata when saving and loading.

Methods

CreateTransaction()

Creates a transaction for making atomic changes to the custom metadata. The Commit() or Dispose() method must be called to apply the changes made within the transaction.