Show / Hide Table of Contents

Class Report

Inheritance
Object
Report
Namespace: AeLa.EasyFeedback
Assembly: cs.temp.dll.dll
Syntax
public class Report

Constructors

Report()

Declaration
public Report()

Fields

Labels

Labels to add to the card on Trello

Declaration
public readonly List<Label> Labels
Field Value
Type Description
List<Label>

List

Trello list this report will be added to

Declaration
public List List
Field Value
Type Description
List

Title

The title of the card on Trello

Declaration
public string Title
Field Value
Type Description
String

Properties

Attachments

Additional files attached to this report

Declaration
public List<FileAttachment> Attachments { get; }
Property Value
Type Description
List<FileAttachment>
Remarks

Private to enforce Trello attachment limit (100)

Item[String]

Returns a section in the report by title

Declaration
public ReportSection this[string sectionTitle] { get; set; }
Parameters
Type Name Description
String sectionTitle
Property Value
Type Description
ReportSection

Methods

AddLabel(Label)

Adds a label to the report.

Declaration
public void AddLabel(Label label)
Parameters
Type Name Description
Label label

AddSection(ReportSection)

Adds a new section to the report

Declaration
public void AddSection(ReportSection section)
Parameters
Type Name Description
ReportSection section

AddSection(String, Int32)

Adds a new empty section to the report

Declaration
public void AddSection(string title, int sortOrder = 0)
Parameters
Type Name Description
String title

The title of the section

Int32 sortOrder

The order of the section on the report (lowest first)

AttachFile(FileAttachment)

Attach a file to the report

Declaration
public void AttachFile(FileAttachment file)
Parameters
Type Name Description
FileAttachment file

AttachFile(String, Byte[])

Attach a file to the report

Declaration
public void AttachFile(string name, byte[] data)
Parameters
Type Name Description
String name

The name of the file

Byte[] data

The file data

AttachFile(String, String)

Attach a file to the report

Declaration
public void AttachFile(string name, string filePath)
Parameters
Type Name Description
String name

The name of the file

String filePath

The path to the file

GetLocalFileText()

Declaration
public string GetLocalFileText()
Returns
Type Description
String

HasLabel(Label)

Checks if the report already has a label.

Declaration
public bool HasLabel(Label label)
Parameters
Type Name Description
Label label
Returns
Type Description
Boolean

HasSection(String)

Checks whether the report already has a section

Declaration
public bool HasSection(string title)
Parameters
Type Name Description
String title
Returns
Type Description
Boolean

RemoveSection(String)

Declaration
public void RemoveSection(string title)
Parameters
Type Name Description
String title

ToString()

Returns the report formatted in markdown for Trello

Declaration
public override string ToString()
Returns
Type Description
String
Overrides
Object.ToString()
Back to top Generated by DocFX