Interface IVersionableReport
Provides an extension point for addins to provide a custom report for an IVersionable item.
Namespace: Algenta.Colectica.ViewModel.Reports
Assembly: Algenta.Colectica.ViewModel.dll
Syntax
public interface IVersionableReportProperties
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(RepositoryItemMetadata)
Determines whether this command should be displayed for the specified item.
Declaration
bool CanCreateReport(RepositoryItemMetadata item)Parameters
| Type | Name | Description |
|---|---|---|
| RepositoryItemMetadata | item | The item for which the report should be generated. |
Returns
| Type | Description |
|---|---|
| bool |
|
Remarks
The value returned from this method determines the Visibility of the command's menu item or button.
CreateReport(RepositoryItemMetadata, RepositoryClientBase)
Builds the report.
Declaration
byte[] CreateReport(RepositoryItemMetadata item, RepositoryClientBase client)Parameters
| Type | Name | Description |
|---|---|---|
| RepositoryItemMetadata | item | |
| RepositoryClientBase | client |
Returns
| Type | Description |
|---|---|
| byte[] |