Base class that represents a collection of all tags contained in a metadata model. More...

Inheritance diagram for FreeImageAPI.Metadata.MetadataModel:

Public Types
enum	VelocityUnit { VelocityUnit.Undefinied, VelocityUnit.Kilometers, VelocityUnit.Miles, VelocityUnit.Knots, VelocityUnit.Undefinied, VelocityUnit.Kilometers, VelocityUnit.Miles, VelocityUnit.Knots }
	Specified different unit types. More...

enum	DirectionReference { DirectionReference.Undefined, DirectionReference.TrueDirection, DirectionReference.MagneticDirection, DirectionReference.Undefined, DirectionReference.TrueDirection, DirectionReference.MagneticDirection }
	Specifies different direction types. More...

enum	LatitudeType { LatitudeType.Undefined, LatitudeType.North, LatitudeType.South, LatitudeType.Undefined, LatitudeType.North, LatitudeType.South }
	Specifies the type of a latitude value. More...

enum	LongitudeType { LongitudeType.Undefined, LongitudeType.East, LongitudeType.West, LongitudeType.Undefined, LongitudeType.East, LongitudeType.West }
	Specifies the type of a longitude value. More...

enum	AltitudeType { AltitudeType.Undefined, AltitudeType.AboveSeaLevel, AltitudeType.BelowSeaLevel, AltitudeType.Undefined, AltitudeType.AboveSeaLevel, AltitudeType.BelowSeaLevel }
	Specifies different altitude types. More...

enum	InteroperabilityMode { InteroperabilityMode.Undefined, InteroperabilityMode.R98, InteroperabilityMode.THM, InteroperabilityMode.Undefined, InteroperabilityMode.R98, InteroperabilityMode.THM }
	Specifies interoperability types. More...

enum	ExifImageOrientation : ushort { ExifImageOrientation.Undefined, ExifImageOrientation.TopLeft = 1, ExifImageOrientation.TopRight, ExifImageOrientation.BottomRight, ExifImageOrientation.BottomLeft, ExifImageOrientation.LeftTop, ExifImageOrientation.RightTop, ExifImageOrientation.RightBottom, ExifImageOrientation.LeftBottom, ExifImageOrientation.Undefined, ExifImageOrientation.TopLeft = 1, ExifImageOrientation.TopRight, ExifImageOrientation.BottomRight, ExifImageOrientation.BottomLeft, ExifImageOrientation.LeftTop, ExifImageOrientation.RightTop, ExifImageOrientation.RightBottom, ExifImageOrientation.LeftBottom }
	Specifies orientation of images. More...

enum	VelocityUnit { VelocityUnit.Undefinied, VelocityUnit.Kilometers, VelocityUnit.Miles, VelocityUnit.Knots, VelocityUnit.Undefinied, VelocityUnit.Kilometers, VelocityUnit.Miles, VelocityUnit.Knots }
	Specified different unit types. More...

enum	DirectionReference { DirectionReference.Undefined, DirectionReference.TrueDirection, DirectionReference.MagneticDirection, DirectionReference.Undefined, DirectionReference.TrueDirection, DirectionReference.MagneticDirection }
	Specifies different direction types. More...

enum	LatitudeType { LatitudeType.Undefined, LatitudeType.North, LatitudeType.South, LatitudeType.Undefined, LatitudeType.North, LatitudeType.South }
	Specifies the type of a latitude value. More...

enum	LongitudeType { LongitudeType.Undefined, LongitudeType.East, LongitudeType.West, LongitudeType.Undefined, LongitudeType.East, LongitudeType.West }
	Specifies the type of a longitude value. More...

enum	AltitudeType { AltitudeType.Undefined, AltitudeType.AboveSeaLevel, AltitudeType.BelowSeaLevel, AltitudeType.Undefined, AltitudeType.AboveSeaLevel, AltitudeType.BelowSeaLevel }
	Specifies different altitude types. More...

enum	InteroperabilityMode { InteroperabilityMode.Undefined, InteroperabilityMode.R98, InteroperabilityMode.THM, InteroperabilityMode.Undefined, InteroperabilityMode.R98, InteroperabilityMode.THM }
	Specifies interoperability types. More...

enum	ExifImageOrientation : ushort { ExifImageOrientation.Undefined, ExifImageOrientation.TopLeft = 1, ExifImageOrientation.TopRight, ExifImageOrientation.BottomRight, ExifImageOrientation.BottomLeft, ExifImageOrientation.LeftTop, ExifImageOrientation.RightTop, ExifImageOrientation.RightBottom, ExifImageOrientation.LeftBottom, ExifImageOrientation.Undefined, ExifImageOrientation.TopLeft = 1, ExifImageOrientation.TopRight, ExifImageOrientation.BottomRight, ExifImageOrientation.BottomLeft, ExifImageOrientation.LeftTop, ExifImageOrientation.RightTop, ExifImageOrientation.RightBottom, ExifImageOrientation.LeftBottom }
	Specifies orientation of images. More...

Public Member Functions
bool	AddTag (MetadataTag tag)
	Adds new tag to the bitmap or updates its value in case it already exists. FreeImageAPI.Metadata.MetadataTag.Key will be used as key. More...

int	AddTag (IEnumerable< MetadataTag > list)
	Adds a list of tags to the bitmap or updates their values in case they already exist. FreeImageAPI.Metadata.MetadataTag.Key will be used as key. More...

bool	RemoveTag (string key)
	Removes the specified tag from the bitmap. More...

bool	DestoryModel ()
	Destroys the metadata model which will remove all tags of this model from the bitmap. More...

MetadataTag	GetTag (string key)
	Returns the specified metadata tag. More...

bool	TagExists (string key)
	Returns whether the specified tag exists. More...

IEnumerator	GetEnumerator ()
	Retrieves an object that can iterate through the individual MetadataTags in this MetadataModel. More...

List< MetadataTag >	RegexSearch (string searchPattern, MD_SEARCH_FLAGS flags)
	Searches for a pattern in each metadata tag and returns the result as a list. More...

override string	ToString ()
	Converts the model of the MetadataModel object to its equivalent string representation. More...

bool	AddTag (MetadataTag tag)
	Adds new tag to the bitmap or updates its value in case it already exists. FreeImageAPI.Metadata.MetadataTag.Key will be used as key. More...

int	AddTag (IEnumerable< MetadataTag > list)
	Adds a list of tags to the bitmap or updates their values in case they already exist. FreeImageAPI.Metadata.MetadataTag.Key will be used as key. More...

bool	RemoveTag (string key)
	Removes the specified tag from the bitmap. More...

bool	DestoryModel ()
	Destroys the metadata model which will remove all tags of this model from the bitmap. More...

MetadataTag	GetTag (string key)
	Returns the specified metadata tag. More...

bool	TagExists (string key)
	Returns whether the specified tag exists. More...

IEnumerator	GetEnumerator ()
	Retrieves an object that can iterate through the individual MetadataTags in this MetadataModel. More...

List< MetadataTag >	RegexSearch (string searchPattern, MD_SEARCH_FLAGS flags)
	Searches for a pattern in each metadata tag and returns the result as a list. More...

override string	ToString ()
	Converts the model of the MetadataModel object to its equivalent string representation. More...

Protected Member Functions
	MetadataModel (FIBITMAP dib)
	Initializes a new instance of this class. More...

MetadataTag	GetTagFromIndex (int index)
	Returns the tag at the given index. More...

T	GetTagValue< T > (string key)
	Returns the value of the specified tag. More...

T[]	GetTagArray< T > (string key)
	Returns an array containing the data of the specified tag. More...

string	GetTagText (string key)
	Returns the string contained by the specified tag. More...

uint[]	GetUInt32Array (string key)
	Returns an array containg the data of the specified tag as unsigned 32bit integer. More...

uint	GetUInt32Value (string key)
	Returns the value of the tag as unsigned 32bit integer. More...

void	SetTagValue< T > (string key, T?value)
	Sets the value of the specified tag. More...

void	SetTagValue (string key, object value)
	Sets the value of the specified tag. More...

void	SetTagValueUndefined (string key, byte[] value)
	Sets the value of the specified tag as undefined. More...

	MetadataModel (FIBITMAP dib)
	Initializes a new instance of this class. More...

MetadataTag	GetTagFromIndex (int index)
	Returns the tag at the given index. More...

T	GetTagValue< T > (string key)
	Returns the value of the specified tag. More...

T[]	GetTagArray< T > (string key)
	Returns an array containing the data of the specified tag. More...

string	GetTagText (string key)
	Returns the string contained by the specified tag. More...

uint[]	GetUInt32Array (string key)
	Returns an array containg the data of the specified tag as unsigned 32bit integer. More...

uint	GetUInt32Value (string key)
	Returns the value of the tag as unsigned 32bit integer. More...

void	SetTagValue< T > (string key, T?value)
	Sets the value of the specified tag. More...

void	SetTagValue (string key, object value)
	Sets the value of the specified tag. More...

void	SetTagValueUndefined (string key, byte[] value)
	Sets the value of the specified tag as undefined. More...

Static Protected Member Functions
static DirectionReference	ToDirectionType (string s)
	Returns the equivalent DirectionReference for the specified String. More...

static string	ToString (DirectionReference?type)
	Returns the equivalent String for the specified DirectionReference. More...

static VelocityUnit	ToUnitType (string s)
	Returns the equivalent VelocityUnit for the specified String. More...

static string	ToString (VelocityUnit?type)
	Returns the equivalent String for the specified VelocityUnit. More...

static LongitudeType	ToLongitudeType (string s)
	Returns the equivalent LongitudeType for the specified String. More...

static string	ToString (LongitudeType?type)
	Returns the equivalent String for the specified LongitudeType. More...

static LatitudeType	ToLatitudeType (string s)
	Returns the equivalent LatitudeType for the specified String. More...

static string	ToString (LatitudeType?type)
	Returns the equivalent String for the specified LatitudeType. More...

static InteroperabilityMode	ToInteroperabilityType (string s)
	Returns the equivalent InteroperabilityMode for the specified String. More...

static string	ToString (InteroperabilityMode?type)
	Returns the equivalent String for the specified InteroperabilityMode. More...

static DirectionReference	ToDirectionType (string s)
	Returns the equivalent DirectionReference for the specified String. More...

static string	ToString (DirectionReference?type)
	Returns the equivalent String for the specified DirectionReference. More...

static VelocityUnit	ToUnitType (string s)
	Returns the equivalent VelocityUnit for the specified String. More...

static string	ToString (VelocityUnit?type)
	Returns the equivalent String for the specified VelocityUnit. More...

static LongitudeType	ToLongitudeType (string s)
	Returns the equivalent LongitudeType for the specified String. More...

static string	ToString (LongitudeType?type)
	Returns the equivalent String for the specified LongitudeType. More...

static LatitudeType	ToLatitudeType (string s)
	Returns the equivalent LatitudeType for the specified String. More...

static string	ToString (LatitudeType?type)
	Returns the equivalent String for the specified LatitudeType. More...

static InteroperabilityMode	ToInteroperabilityType (string s)
	Returns the equivalent InteroperabilityMode for the specified String. More...

static string	ToString (InteroperabilityMode?type)
	Returns the equivalent String for the specified InteroperabilityMode. More...

Protected Attributes
readonly FIBITMAP	dib
	Handle to the encapsulated FreeImage-bitmap. More...

Properties
abstract FREE_IMAGE_MDMODEL	Model `[get]`
	Retrieves the datamodel that this instance represents. More...

List< MetadataTag >	List `[get]`
	Returns a list of all metadata tags this instance represents. More...

MetadataTag	this[int index] `[get]`
	Returns the metadata tag at the given index. This operation is slow when accessing all tags. More...

int	Count `[get]`
	Returns the number of metadata tags this instance represents. More...

bool	Exists `[get]`
	Returns whether this model exists in the bitmaps metadata structure. More...

Detailed Description

Base class that represents a collection of all tags contained in a metadata model.

The MetedataModel class is an abstract base class, which is inherited by several derived classes, one for each existing metadata model.

Definition at line 51 of file MetadataModel.cs.

Member Enumeration Documentation

enum FreeImageAPI.Metadata.MetadataModel.AltitudeType

Specifies different altitude types.

Enumerator
Undefined	No or unknown type.
AboveSeaLevel	East.
BelowSeaLevel	West.
Undefined	No or unknown type.
AboveSeaLevel	East.
BelowSeaLevel	West.

Definition at line 839 of file MetadataModel.cs.

enum FreeImageAPI.Metadata.MetadataModel.AltitudeType

Specifies different altitude types.

Enumerator
Undefined	No or unknown type.
AboveSeaLevel	East.
BelowSeaLevel	West.
Undefined	No or unknown type.
AboveSeaLevel	East.
BelowSeaLevel	West.

Definition at line 839 of file MetadataModel.cs.

enum FreeImageAPI.Metadata.MetadataModel.DirectionReference

Specifies different direction types.

Enumerator
Undefined	No or unknown direction type.
TrueDirection	True direction.
MagneticDirection	Magnatic direction.
Undefined	No or unknown direction type.
TrueDirection	True direction.
MagneticDirection	Magnatic direction.

Definition at line 776 of file MetadataModel.cs.

enum FreeImageAPI.Metadata.MetadataModel.DirectionReference

Specifies different direction types.

Enumerator
Undefined	No or unknown direction type.
TrueDirection	True direction.
MagneticDirection	Magnatic direction.
Undefined	No or unknown direction type.
TrueDirection	True direction.
MagneticDirection	Magnatic direction.

Definition at line 776 of file MetadataModel.cs.

enum FreeImageAPI.Metadata.MetadataModel.ExifImageOrientation : ushort

Specifies orientation of images.

Enumerator
Undefined	Undefinied orientation.
TopLeft	TopLeft.
TopRight	TopRight.
BottomRight	BottomRight.
BottomLeft	BottomLeft.
LeftTop	LeftTop.
RightTop	RightTop.
RightBottom	RightBottom.
LeftBottom	LeftBottom.
Undefined	Undefinied orientation.
TopLeft	TopLeft.
TopRight	TopRight.
BottomRight	BottomRight.
BottomLeft	BottomLeft.
LeftTop	LeftTop.
RightTop	RightTop.
RightBottom	RightBottom.
LeftBottom	LeftBottom.

Definition at line 884 of file MetadataModel.cs.

enum FreeImageAPI.Metadata.MetadataModel.ExifImageOrientation : ushort

Specifies orientation of images.

Enumerator
Undefined	Undefinied orientation.
TopLeft	TopLeft.
TopRight	TopRight.
BottomRight	BottomRight.
BottomLeft	BottomLeft.
LeftTop	LeftTop.
RightTop	RightTop.
RightBottom	RightBottom.
LeftBottom	LeftBottom.
Undefined	Undefinied orientation.
TopLeft	TopLeft.
TopRight	TopRight.
BottomRight	BottomRight.
BottomLeft	BottomLeft.
LeftTop	LeftTop.
RightTop	RightTop.
RightBottom	RightBottom.
LeftBottom	LeftBottom.

Definition at line 884 of file MetadataModel.cs.

enum FreeImageAPI.Metadata.MetadataModel.InteroperabilityMode

Specifies interoperability types.

Enumerator
Undefined	No or unknown type.
R98	Indicates a file conforming to R98 file specification of Recommended Exif Interoperability Rules (ExifR98) or to DCF basic file stipulated by Design Rule for Camera File System.
THM	Indicates a file conforming to DCF thumbnail file stipulated by Design rule for Camera File System.
Undefined	No or unknown type.
R98	Indicates a file conforming to R98 file specification of Recommended Exif Interoperability Rules (ExifR98) or to DCF basic file stipulated by Design Rule for Camera File System.
THM	Indicates a file conforming to DCF thumbnail file stipulated by Design rule for Camera File System.

Definition at line 860 of file MetadataModel.cs.

enum FreeImageAPI.Metadata.MetadataModel.InteroperabilityMode

Specifies interoperability types.

Enumerator
Undefined	No or unknown type.
R98	Indicates a file conforming to R98 file specification of Recommended Exif Interoperability Rules (ExifR98) or to DCF basic file stipulated by Design Rule for Camera File System.
THM	Indicates a file conforming to DCF thumbnail file stipulated by Design rule for Camera File System.
Undefined	No or unknown type.
R98	Indicates a file conforming to R98 file specification of Recommended Exif Interoperability Rules (ExifR98) or to DCF basic file stipulated by Design Rule for Camera File System.
THM	Indicates a file conforming to DCF thumbnail file stipulated by Design rule for Camera File System.

Definition at line 860 of file MetadataModel.cs.

enum FreeImageAPI.Metadata.MetadataModel.LatitudeType

Specifies the type of a latitude value.

Enumerator
Undefined	No or unknown type.
North	North.
South	South.
Undefined	No or unknown type.
North	North.
South	South.

Definition at line 797 of file MetadataModel.cs.

enum FreeImageAPI.Metadata.MetadataModel.LatitudeType

Specifies the type of a latitude value.

Enumerator
Undefined	No or unknown type.
North	North.
South	South.
Undefined	No or unknown type.
North	North.
South	South.

Definition at line 797 of file MetadataModel.cs.

enum FreeImageAPI.Metadata.MetadataModel.LongitudeType

Specifies the type of a longitude value.

Enumerator
Undefined	No or unknown type.
East	East.
West	West.
Undefined	No or unknown type.
East	East.
West	West.

Definition at line 818 of file MetadataModel.cs.

enum FreeImageAPI.Metadata.MetadataModel.LongitudeType

Specifies the type of a longitude value.

Enumerator
Undefined	No or unknown type.
East	East.
West	West.
Undefined	No or unknown type.
East	East.
West	West.

Definition at line 818 of file MetadataModel.cs.

enum FreeImageAPI.Metadata.MetadataModel.VelocityUnit

Specified different unit types.

Enumerator
Undefinied	No or unknown type.
Kilometers	Kilometers per hour.
Miles	Miles per hour.
Knots	Knots.
Undefinied	No or unknown type.
Kilometers	Kilometers per hour.
Miles	Miles per hour.
Knots	Knots.

Definition at line 750 of file MetadataModel.cs.

enum FreeImageAPI.Metadata.MetadataModel.VelocityUnit

Specified different unit types.

Enumerator
Undefinied	No or unknown type.
Kilometers	Kilometers per hour.
Miles	Miles per hour.
Knots	Knots.
Undefinied	No or unknown type.
Kilometers	Kilometers per hour.
Miles	Miles per hour.
Knots	Knots.

Definition at line 750 of file MetadataModel.cs.

Constructor & Destructor Documentation

FreeImageAPI.Metadata.MetadataModel.MetadataModel ( FIBITMAP dib )

protected

Initializes a new instance of this class.

Parameters

dib	Handle to a FreeImage bitmap.

Exceptions

ArgumentNullException dib is null.

Definition at line 65 of file MetadataModel.cs.

References FreeImageAPI.FIBITMAP.IsNull.

FreeImageAPI.Metadata.MetadataModel.MetadataModel ( FIBITMAP dib )

protected

Initializes a new instance of this class.

Parameters

dib	Handle to a FreeImage bitmap.

Exceptions

ArgumentNullException dib is null.

Definition at line 65 of file MetadataModel.cs.

References FreeImageAPI.FIBITMAP.IsNull.

Member Function Documentation

bool FreeImageAPI.Metadata.MetadataModel.AddTag ( MetadataTag tag )

Adds new tag to the bitmap or updates its value in case it already exists. FreeImageAPI.Metadata.MetadataTag.Key will be used as key.

Parameters

tag	The tag to add or update.

Returns: Returns true on success, false on failure.

Exceptions

ArgumentNullException	tag is null.
ArgumentException	The tags model differs from this instances model.

Definition at line 92 of file MetadataModel.cs.

References FreeImageAPI.Metadata.MetadataTag.Model.

bool FreeImageAPI.Metadata.MetadataModel.AddTag ( MetadataTag tag )

Adds new tag to the bitmap or updates its value in case it already exists. FreeImageAPI.Metadata.MetadataTag.Key will be used as key.

Parameters

tag	The tag to add or update.

Returns: Returns true on success, false on failure.

Exceptions

ArgumentNullException	tag is null.
ArgumentException	The tags model differs from this instances model.

Definition at line 92 of file MetadataModel.cs.

References FreeImageAPI.Metadata.MetadataTag.Model.

int FreeImageAPI.Metadata.MetadataModel.AddTag ( IEnumerable< MetadataTag > list )

Adds a list of tags to the bitmap or updates their values in case they already exist. FreeImageAPI.Metadata.MetadataTag.Key will be used as key.

Parameters

list	A list of tags to add or update.

Returns: Returns the number of successfully added tags.

Exceptions

ArgumentNullException list is null.

Definition at line 113 of file MetadataModel.cs.

References FreeImageAPI.Metadata.MetadataTag.AddToImage(), DirectX.count, and FreeImageAPI.Metadata.MetadataTag.Model.

int FreeImageAPI.Metadata.MetadataModel.AddTag ( IEnumerable< MetadataTag > list )

Adds a list of tags to the bitmap or updates their values in case they already exist. FreeImageAPI.Metadata.MetadataTag.Key will be used as key.

Parameters

list	A list of tags to add or update.

Returns: Returns the number of successfully added tags.

Exceptions

ArgumentNullException list is null.

Definition at line 113 of file MetadataModel.cs.

References FreeImageAPI.Metadata.MetadataTag.AddToImage(), DirectX.count, and FreeImageAPI.Metadata.MetadataTag.Model.

bool FreeImageAPI.Metadata.MetadataModel.DestoryModel ( )

Destroys the metadata model which will remove all tags of this model from the bitmap.

Returns: Returns true on success, false on failure.

Definition at line 151 of file MetadataModel.cs.

References FreeImageAPI.FITAG.Zero.

bool FreeImageAPI.Metadata.MetadataModel.DestoryModel ( )

Destroys the metadata model which will remove all tags of this model from the bitmap.

Returns: Returns true on success, false on failure.

Definition at line 151 of file MetadataModel.cs.

References FreeImageAPI.FITAG.Zero.

IEnumerator FreeImageAPI.Metadata.MetadataModel.GetEnumerator ( )

Retrieves an object that can iterate through the individual MetadataTags in this MetadataModel.

Returns: An IEnumerator for the FreeImageAPI.Metadata.MetadataModel.

Definition at line 269 of file MetadataModel.cs.

IEnumerator FreeImageAPI.Metadata.MetadataModel.GetEnumerator ( )

Retrieves an object that can iterate through the individual MetadataTags in this MetadataModel.

Returns: An IEnumerator for the FreeImageAPI.Metadata.MetadataModel.

Definition at line 269 of file MetadataModel.cs.

MetadataTag FreeImageAPI.Metadata.MetadataModel.GetTag ( string key )

Returns the specified metadata tag.

Parameters

key	The key of the tag.

Returns: The metadata tag.

Exceptions

ArgumentNullException key is null.

Definition at line 163 of file MetadataModel.cs.

MetadataTag FreeImageAPI.Metadata.MetadataModel.GetTag ( string key )

Returns the specified metadata tag.

Parameters

key	The key of the tag.

Returns: The metadata tag.

Exceptions

ArgumentNullException key is null.

Definition at line 163 of file MetadataModel.cs.

T [] FreeImageAPI.Metadata.MetadataModel.GetTagArray< T > ( string key )

protected

Returns an array containing the data of the specified tag.

Template Parameters

T	The type of the tag's data.

Parameters

key	The key of the tag.

Returns: An array containing the data of the specified tag.

Type Constraints

T

:

struct

Definition at line 368 of file MetadataModel.cs.

T [] FreeImageAPI.Metadata.MetadataModel.GetTagArray< T > ( string key )

protected

Returns an array containing the data of the specified tag.

Template Parameters

T	The type of the tag's data.

Parameters

key	The key of the tag.

Returns: An array containing the data of the specified tag.

Type Constraints

T

:

struct

Definition at line 368 of file MetadataModel.cs.

MetadataTag FreeImageAPI.Metadata.MetadataModel.GetTagFromIndex ( int index )

protected

Returns the tag at the given index.

Parameters

index Index of the tag to return.

Returns: The tag at the given index.

Definition at line 218 of file MetadataModel.cs.

References DirectX.count, and FreeImageAPI.FIMETADATA.IsNull.

MetadataTag FreeImageAPI.Metadata.MetadataModel.GetTagFromIndex ( int index )

protected

Returns the tag at the given index.

Parameters

index Index of the tag to return.

Returns: The tag at the given index.

Definition at line 218 of file MetadataModel.cs.

References DirectX.count, and FreeImageAPI.FIMETADATA.IsNull.

string FreeImageAPI.Metadata.MetadataModel.GetTagText ( string key )

protected

Returns the string contained by the specified tag.

Parameters

key	The key of the tag.

Returns: The string contained by the specified tag.

Definition at line 383 of file MetadataModel.cs.

string FreeImageAPI.Metadata.MetadataModel.GetTagText ( string key )

protected

Returns the string contained by the specified tag.

Parameters

key	The key of the tag.

Returns: The string contained by the specified tag.

Definition at line 383 of file MetadataModel.cs.

T FreeImageAPI.Metadata.MetadataModel.GetTagValue< T > ( string key )

protected

Returns the value of the specified tag.

Template Parameters

T	Type of the tag's data.

Parameters

key	The key of the tag.

Returns: The value of the specified tag.

Type Constraints

T

:

struct

Definition at line 344 of file MetadataModel.cs.

T FreeImageAPI.Metadata.MetadataModel.GetTagValue< T > ( string key )

protected

Returns the value of the specified tag.

Template Parameters

T	Type of the tag's data.

Parameters

key	The key of the tag.

Returns: The value of the specified tag.

Type Constraints

T

:

struct

Definition at line 344 of file MetadataModel.cs.

uint [] FreeImageAPI.Metadata.MetadataModel.GetUInt32Array ( string key )

protected

Returns an array containg the data of the specified tag as unsigned 32bit integer.

Parameters

key	The key of the tag.

Returns: An array containg the data of the specified tag as unsigned 32bit integer.

Definition at line 400 of file MetadataModel.cs.

uint [] FreeImageAPI.Metadata.MetadataModel.GetUInt32Array ( string key )

protected

Returns an array containg the data of the specified tag as unsigned 32bit integer.

Parameters

key	The key of the tag.

Returns: An array containg the data of the specified tag as unsigned 32bit integer.

Definition at line 400 of file MetadataModel.cs.

uint FreeImageAPI.Metadata.MetadataModel.GetUInt32Value ( string key )

protected

Returns the value of the tag as unsigned 32bit integer.

Parameters

key	The key of the tag.

Returns: The value of the tag as unsigned 32bit integer.

Definition at line 436 of file MetadataModel.cs.

uint FreeImageAPI.Metadata.MetadataModel.GetUInt32Value ( string key )

protected

Returns the value of the tag as unsigned 32bit integer.

Parameters

key	The key of the tag.

Returns: The value of the tag as unsigned 32bit integer.

Definition at line 436 of file MetadataModel.cs.

List<MetadataTag> FreeImageAPI.Metadata.MetadataModel.RegexSearch	(	string	searchPattern,
		MD_SEARCH_FLAGS	flags
	)

Searches for a pattern in each metadata tag and returns the result as a list.

Parameters

searchPattern	The regular expression to use for the search.
flags	A bitfield that controls which fields should be searched in.

Returns: A list containing all found metadata tags.

Exceptions

ArgumentNullException	searchPattern is null.
ArgumentException	searchPattern is empty.

Definition at line 303 of file MetadataModel.cs.

References FreeImageAPI.Metadata.MetadataTag.Description, DirectX.flags, FreeImageAPI.Metadata.MetadataTag.Key, and FreeImageAPI.Metadata.MetadataTag.ToString().

List<MetadataTag> FreeImageAPI.Metadata.MetadataModel.RegexSearch	(	string	searchPattern,
		MD_SEARCH_FLAGS	flags
	)

Searches for a pattern in each metadata tag and returns the result as a list.

Parameters

searchPattern	The regular expression to use for the search.
flags	A bitfield that controls which fields should be searched in.

Returns: A list containing all found metadata tags.

Exceptions

ArgumentNullException	searchPattern is null.
ArgumentException	searchPattern is empty.

Definition at line 303 of file MetadataModel.cs.

References FreeImageAPI.Metadata.MetadataTag.Description, DirectX.flags, FreeImageAPI.Metadata.MetadataTag.Key, and FreeImageAPI.Metadata.MetadataTag.ToString().

bool FreeImageAPI.Metadata.MetadataModel.RemoveTag ( string key )

Removes the specified tag from the bitmap.

Parameters

key	The key of the tag.

Returns: Returns true on success, false on failure.

Exceptions

ArgumentNullException key is null.

Definition at line 137 of file MetadataModel.cs.

References FreeImageAPI.FITAG.Zero.

bool FreeImageAPI.Metadata.MetadataModel.RemoveTag ( string key )

Removes the specified tag from the bitmap.

Parameters

key	The key of the tag.

Returns: Returns true on success, false on failure.

Exceptions

ArgumentNullException key is null.

Definition at line 137 of file MetadataModel.cs.

References FreeImageAPI.FITAG.Zero.

void FreeImageAPI.Metadata.MetadataModel.SetTagValue	(	string	key,
		object	value
	)

protected

Sets the value of the specified tag.

Parameters

key	The key of the tag.
value	The new value of the specified tag or null.

Definition at line 458 of file MetadataModel.cs.

void FreeImageAPI.Metadata.MetadataModel.SetTagValue	(	string	key,
		object	value
	)

protected

Sets the value of the specified tag.

Parameters

key	The key of the tag.
value	The new value of the specified tag or null.

Definition at line 458 of file MetadataModel.cs.

void FreeImageAPI.Metadata.MetadataModel.SetTagValue< T >	(	string	key,
		T?	value
	)

protected

Sets the value of the specified tag.

Template Parameters

T	The type of the tag's data.

Parameters

key	The key of the tag.
value	The new value of the specified tag or null.

Type Constraints

T

:

struct

Definition at line 448 of file MetadataModel.cs.

void FreeImageAPI.Metadata.MetadataModel.SetTagValue< T >	(	string	key,
		T?	value
	)

protected

Sets the value of the specified tag.

Template Parameters

T	The type of the tag's data.

Parameters

key	The key of the tag.
value	The new value of the specified tag or null.

Type Constraints

T

:

struct

Definition at line 448 of file MetadataModel.cs.

void FreeImageAPI.Metadata.MetadataModel.SetTagValueUndefined	(	string	key,
		byte[]	value
	)

protected

Sets the value of the specified tag as undefined.

Parameters

key	The key of the tag.
value	The new value of the specified tag or null.

Definition at line 490 of file MetadataModel.cs.

void FreeImageAPI.Metadata.MetadataModel.SetTagValueUndefined	(	string	key,
		byte[]	value
	)

protected

Sets the value of the specified tag as undefined.

Parameters

key	The key of the tag.
value	The new value of the specified tag or null.

Definition at line 490 of file MetadataModel.cs.

bool FreeImageAPI.Metadata.MetadataModel.TagExists ( string key )

Returns whether the specified tag exists.

Parameters

key	The key of the tag.

Returns: True in case the tag exists, else false.

Exceptions

ArgumentNullException key is null.

Definition at line 180 of file MetadataModel.cs.

bool FreeImageAPI.Metadata.MetadataModel.TagExists ( string key )

Returns whether the specified tag exists.

Parameters

key	The key of the tag.

Returns: True in case the tag exists, else false.

Exceptions

ArgumentNullException key is null.

Definition at line 180 of file MetadataModel.cs.

static DirectionReference FreeImageAPI.Metadata.MetadataModel.ToDirectionType ( string s )

staticprotected

Returns the equivalent DirectionReference for the specified String.

Parameters

s	The string containing the DirectionReference.

Returns: The equivalent DirectionReference for the specified String.

Definition at line 524 of file MetadataModel.cs.

static DirectionReference FreeImageAPI.Metadata.MetadataModel.ToDirectionType ( string s )

staticprotected

Returns the equivalent DirectionReference for the specified String.

Parameters

s	The string containing the DirectionReference.

Returns: The equivalent DirectionReference for the specified String.

Definition at line 524 of file MetadataModel.cs.

static InteroperabilityMode FreeImageAPI.Metadata.MetadataModel.ToInteroperabilityType ( string s )

staticprotected

Returns the equivalent InteroperabilityMode for the specified String.

Parameters

s	The string containing the InteroperabilityMode.

Returns: The equivalent InteroperabilityMode for the specified String.

Definition at line 712 of file MetadataModel.cs.

static InteroperabilityMode FreeImageAPI.Metadata.MetadataModel.ToInteroperabilityType ( string s )

staticprotected

Returns the equivalent InteroperabilityMode for the specified String.

Parameters

s	The string containing the InteroperabilityMode.

Returns: The equivalent InteroperabilityMode for the specified String.

Definition at line 712 of file MetadataModel.cs.

static LatitudeType FreeImageAPI.Metadata.MetadataModel.ToLatitudeType ( string s )

staticprotected

Returns the equivalent LatitudeType for the specified String.

Parameters

s	The string containing the LatitudeType.

Returns: The equivalent LatitudeType for the specified String.

Definition at line 666 of file MetadataModel.cs.

static LatitudeType FreeImageAPI.Metadata.MetadataModel.ToLatitudeType ( string s )

staticprotected

Returns the equivalent LatitudeType for the specified String.

Parameters

s	The string containing the LatitudeType.

Returns: The equivalent LatitudeType for the specified String.

Definition at line 666 of file MetadataModel.cs.

static LongitudeType FreeImageAPI.Metadata.MetadataModel.ToLongitudeType ( string s )

staticprotected

Returns the equivalent LongitudeType for the specified String.

Parameters

s	The string containing the LongitudeType.

Returns: The equivalent LongitudeType for the specified String.

Definition at line 620 of file MetadataModel.cs.

static LongitudeType FreeImageAPI.Metadata.MetadataModel.ToLongitudeType ( string s )

staticprotected

Returns the equivalent LongitudeType for the specified String.

Parameters

s	The string containing the LongitudeType.

Returns: The equivalent LongitudeType for the specified String.

Definition at line 620 of file MetadataModel.cs.

static string FreeImageAPI.Metadata.MetadataModel.ToString ( DirectionReference? type )

staticprotected

Returns the equivalent String for the specified DirectionReference.

Parameters

type	The DirectionReference to convert.

Returns: The equivalent String for the specified DirectionReference.

Definition at line 546 of file MetadataModel.cs.

static string FreeImageAPI.Metadata.MetadataModel.ToString ( DirectionReference? type )

staticprotected

Returns the equivalent String for the specified DirectionReference.

Parameters

type	The DirectionReference to convert.

Returns: The equivalent String for the specified DirectionReference.

Definition at line 546 of file MetadataModel.cs.

static string FreeImageAPI.Metadata.MetadataModel.ToString ( VelocityUnit? type )

staticprotected

Returns the equivalent String for the specified VelocityUnit.

Parameters

type	The VelocityUnit to convert.

Returns: The equivalent String for the specified VelocityUnit.

Definition at line 594 of file MetadataModel.cs.

static string FreeImageAPI.Metadata.MetadataModel.ToString ( VelocityUnit? type )

staticprotected

Returns the equivalent String for the specified VelocityUnit.

Parameters

type	The VelocityUnit to convert.

Returns: The equivalent String for the specified VelocityUnit.

Definition at line 594 of file MetadataModel.cs.

static string FreeImageAPI.Metadata.MetadataModel.ToString ( LongitudeType? type )

staticprotected

Returns the equivalent String for the specified LongitudeType.

Parameters

type	The LongitudeType to convert.

Returns: The equivalent String for the specified LongitudeType.

Definition at line 642 of file MetadataModel.cs.

static string FreeImageAPI.Metadata.MetadataModel.ToString ( LongitudeType? type )

staticprotected

Returns the equivalent String for the specified LongitudeType.

Parameters

type	The LongitudeType to convert.

Returns: The equivalent String for the specified LongitudeType.

Definition at line 642 of file MetadataModel.cs.

static string FreeImageAPI.Metadata.MetadataModel.ToString ( LatitudeType? type )

staticprotected

Returns the equivalent String for the specified LatitudeType.

Parameters

type	The LatitudeType to convert.

Returns: The equivalent String for the specified LatitudeType.

Definition at line 688 of file MetadataModel.cs.

static string FreeImageAPI.Metadata.MetadataModel.ToString ( LatitudeType? type )

staticprotected

Returns the equivalent String for the specified LatitudeType.

Parameters

type	The LatitudeType to convert.

Returns: The equivalent String for the specified LatitudeType.

Definition at line 688 of file MetadataModel.cs.

static string FreeImageAPI.Metadata.MetadataModel.ToString ( InteroperabilityMode? type )

staticprotected

Returns the equivalent String for the specified InteroperabilityMode.

Parameters

type	The InteroperabilityMode to convert.

Returns: The equivalent String for the specified InteroperabilityMode.

Definition at line 730 of file MetadataModel.cs.

static string FreeImageAPI.Metadata.MetadataModel.ToString ( InteroperabilityMode? type )

staticprotected

Returns the equivalent String for the specified InteroperabilityMode.

Parameters

type	The InteroperabilityMode to convert.

Returns: The equivalent String for the specified InteroperabilityMode.

Definition at line 730 of file MetadataModel.cs.

override string FreeImageAPI.Metadata.MetadataModel.ToString ( )

Converts the model of the MetadataModel object to its equivalent string representation.

Returns: The string representation of the value of this instance.

Definition at line 936 of file MetadataModel.cs.

override string FreeImageAPI.Metadata.MetadataModel.ToString ( )

Converts the model of the MetadataModel object to its equivalent string representation.

Returns: The string representation of the value of this instance.

Definition at line 936 of file MetadataModel.cs.

static VelocityUnit FreeImageAPI.Metadata.MetadataModel.ToUnitType ( string s )

staticprotected

Returns the equivalent VelocityUnit for the specified String.

Parameters

s	The string containing the VelocityUnit.

Returns: The equivalent VelocityUnit for the specified String.

Definition at line 570 of file MetadataModel.cs.

static VelocityUnit FreeImageAPI.Metadata.MetadataModel.ToUnitType ( string s )

staticprotected

Returns the equivalent VelocityUnit for the specified String.

Parameters

s	The string containing the VelocityUnit.

Returns: The equivalent VelocityUnit for the specified String.

Definition at line 570 of file MetadataModel.cs.

Member Data Documentation

readonly FIBITMAP FreeImageAPI.Metadata.MetadataModel.dib

protected

Handle to the encapsulated FreeImage-bitmap.

Definition at line 57 of file MetadataModel.cs.

Property Documentation

int FreeImageAPI.Metadata.MetadataModel.Count

get

Returns the number of metadata tags this instance represents.

Definition at line 278 of file MetadataModel.cs.

bool FreeImageAPI.Metadata.MetadataModel.Exists

get

Returns whether this model exists in the bitmaps metadata structure.

Definition at line 286 of file MetadataModel.cs.

List< MetadataTag > FreeImageAPI.Metadata.MetadataModel.List

get

Returns a list of all metadata tags this instance represents.

Definition at line 194 of file MetadataModel.cs.

abstract FREE_IMAGE_MDMODEL FreeImageAPI.Metadata.MetadataModel.Model

get

Retrieves the datamodel that this instance represents.

Definition at line 78 of file MetadataModel.cs.

MetadataTag FreeImageAPI.Metadata.MetadataModel.this[int index]

get

Returns the metadata tag at the given index. This operation is slow when accessing all tags.

Parameters

index Index of the tag.

Returns: The metadata tag.

Exceptions

ArgumentOutOfRangeException index is greater or equal Count or index is less than zero.

Definition at line 257 of file MetadataModel.cs.

The documentation for this class was generated from the following file:

D:/Projects/Bitbucket Hosting/DoxygenFilesAndSources/Paradox v1.0.0 beta06/sources/tools/SiliconStudio.TextureConverter/Backend/Wrappers/FINetWrapper/Classes/MetadataModel.cs

Public Types

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Properties

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation