Interface IItemListReport

Provides an extension point to creates a report for an ItemList.

Namespace: Algenta.Colectica.ViewModel.Reports

Assembly: Algenta.Colectica.ViewModel.dll

Syntax

public interface IItemListReport

Properties

DefaultExtension

The default file extension for the file to be created, to be displayed in the SaveFileDialog in a user interface.

Declaration

string DefaultExtension { get; }

Property Value

Type	Description
string

FileTypeDescription

A description of the file type to be created, to be displayed in the SaveFileDialog in a user interface.

Declaration

string FileTypeDescription { get; }

Property Value

Type	Description
string

MimeType

The MIME type of the created file, used when returning the file via the Web.

Declaration

string MimeType { get; }

Property Value

Type	Description
string

Path

Gets the path suffix to be used when calling the output builder from Portal.

Declaration

string Path { get; }

Property Value

Type	Description
string

Title

Gets a title for the report.

Declaration

string Title { get; }

Property Value

Type	Description
string

Methods

CanCreateReport(DublinCore, List<RepositoryItemMetadata>)

Determines whether this command should be displayed for the specified item.

Declaration

bool CanCreateReport(DublinCore citation, List<RepositoryItemMetadata> items)

Parameters

Type	Name	Description
DublinCore	citation
List<RepositoryItemMetadata>	items

Returns

Type	Description
bool	true if the command should be displayed for the specified item; otherwise false.

Remarks

The value returned from this method determines the Visibility of the command's menu item or button.

CreateReport(DublinCore, List<RepositoryItemMetadata>, RepositoryClientBase)

Builds the report.

Declaration

byte[] CreateReport(DublinCore citation, List<RepositoryItemMetadata> items, RepositoryClientBase client)

Parameters

Type	Name	Description
DublinCore	citation
List<RepositoryItemMetadata>	items
RepositoryClientBase	client

Returns

Type	Description
byte[]