MFGS Email Resource Collection

MFGSEmailResourceCollection Public interface

Description

Represents a collection of email resources.

Diagram

  flowchart LR
  classDef interfaceStyle stroke-dasharray: 5 5;
  classDef abstractStyle stroke-width:4px
  subgraph VGWWCoreIEx
  VGWWCoreIEx.IExMFGSEmailResourceCollection[[IExMFGSEmailResourceCollection]]
  class VGWWCoreIEx.IExMFGSEmailResourceCollection interfaceStyle;
  end

Members

Properties

Public properties

Type	Name	Methods
int	Count Gets the number of resources in the collection	get
IExMFGSEmailResource	Item	get

Methods

Public methods

Returns	Name
IExMFGSEmailResource	Add(string filePath) Add a file to the resource collection.
void	Clear() Clears the collection.
string	Join(string separator) Concatenates the name of each resource in the collection.
void	ParseAdd(string filePathList, string delimiter) Add multiple files to the reaource collection.
bool	Remove(string name, bool ignoreCase) Remove an resource from the collection.
void	RemoveAt(int index) Remove the resource at the specified index from the collection.

Details

Summary

Represents a collection of email resources.

Remarks

Often referred to a linked or emmbedded resources.

Methods

Join

public string Join(string separator)

Arguments

Type	Name	Description
string	separator	The separator between each resource name.

Summary

Concatenates the name of each resource in the collection.

Returns

A string of resource names.

Clear

public void Clear()

Summary

Clears the collection.

Add

public IExMFGSEmailResource Add(string filePath)

Arguments

Type	Name	Description
string	filePath	The path to the file.

Summary

Add a file to the resource collection.

Returns

The IExMFGSEmailResource object, containing the file, which was added to the collection.

ParseAdd

public void ParseAdd(string filePathList, string delimiter)

Arguments

Type	Name	Description
string	filePathList	A delimited list of files to be added.
string	delimiter	The delimiter to be used when parsing the list.

Summary

Add multiple files to the reaource collection.

Remove

public bool Remove(string name, bool ignoreCase)

Arguments

Type	Name	Description
string	name	The name of the resource to remove.
bool	ignoreCase	Determine if case should be ignored.

Summary

Remove an resource from the collection.

Returns

true if one or more resources were found and removed, otherwise false.

RemoveAt

public void RemoveAt(int index)

Arguments

Type	Name	Description
int	index	The index of the resource.

Summary

Remove the resource at the specified index from the collection.

Properties

Count

public int Count { get; }

Summary

Gets the number of resources in the collection

Item

public IExMFGSEmailResource Item { get; }

Generated with ModularDoc