Show / Hide Table of Contents

Class ItemBuilderBase

Inheritance
object
ItemBuilderBase
ActionActivityBuilder
ArchiveBuilder
CategoryBuilder
CategorySchemeBuilder
ClassificationCorrespondenceTableBuilder
ClassificationFamilyBuilder
ClassificationIndexBuilder
ClassificationItemBuilder
ClassificationLevelBuilder
ClassificationSeriesBuilder
CodeListBuilder
CodeListSchemeBuilder
ConceptBuilder
ConceptSchemeBuilder
ConceptualComponentBuilder
ConceptualVariableBuilder
ConceptualVariableSchemeBuilder
ControlConstructSchemeBuilder
CustomIfElseActivityBuilder
CustomLoopActivityBuilder
CustomSequenceActivityBuilder
CustomUntilActivityBuilder
CustomWhileActivityBuilder
DataCollectionBuilder
DataCollectionMethodologyBuilder
DataRelationshipBuilder
DdiInstanceBuilder
GeneralInstructionCodingBuilder
GenerationInstructionCodingBuilder
GenericGroupBuilder<T, G>
GroupBuilder
IndividualBuilder
InformationClassificationBuilder
InstrumentBuilder
InstrumentSchemeBuilder
InterviewerInstructionBuilder
InterviewerInstructionSchemeBuilder
LogicalProductBuilder
ManagedDateTimeRepresentationBuilder
ManagedMissingValuesRepresentationBuilder
ManagedNumericRepresentationBuilder
ManagedRepresentationSchemeBuilder
ManagedScaleRepresentationBuilder
ManagedTextRepresentationBuilder
MeasurementBuilder
NCubeBuilder
NCubeSchemeBuilder
OrganizationBuilder
OrganizationSchemeBuilder
OtherMaterialBuilder
OtherMaterialGroupBuilder
OtherMaterialSchemeBuilder
PaperFormBuilder
PhysicalInstanceBuilder
PhysicalProductBuilder
PhysicalStructureBuilder
PhysicalStructureSchemeBuilder
ProcessingEventBuilder
ProcessingEventSchemeBuilder
ProcessingInstructionGroupBuilder
ProcessingInstructionSchemeBuilder
QualityStandardBuilder
QualityStatementBuilder
QualityStatementSchemeBuilder
QuestionActivityBuilder
QuestionBlockBuilder
QuestionBuilder
QuestionGridBuilder
QuestionGroupBuilder
QuestionSchemeBuilder
RecordLayoutBuilder
RecordLayoutSchemeBuilder
RepresentedVariableBuilder
RepresentedVariableSchemeBuilder
ResourcePackageBuilder
StatementActivityBuilder
StatisticalClassificationBuilder
StudyUnitBuilder
SubGroupBuilder
UnitTypeBuilder
UnitTypeGroupBuilder
UnitTypeSchemeBuilder
UniverseBuilder
UniverseSchemeBuilder
UnsupportedTypeBuilder
VariableBuilder
VariableSchemeBuilder
VariableStatisticBuilder
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Namespace: Colectica.Reporting
Assembly: Colectica.Reporting.dll
Syntax
public class ItemBuilderBase

Constructors

ItemBuilderBase(Document, ReportContext)

Declaration
public ItemBuilderBase(Document document, ReportContext context)
Parameters
Type Name Description
Document document
ReportContext context

Properties

Context

Declaration
public ReportContext Context { get; set; }
Property Value
Type Description
ReportContext

Document

Declaration
public Document Document { get; set; }
Property Value
Type Description
Document

HeaderLevel

Declaration
public int HeaderLevel { get; set; }
Property Value
Type Description
int

IndentClass

Declaration
public string IndentClass { get; }
Property Value
Type Description
string

IndentLevel

Declaration
public int IndentLevel { get; set; }
Property Value
Type Description
int

SuppressHeader

Declaration
public bool SuppressHeader { get; set; }
Property Value
Type Description
bool

ViewBag

Declaration
public dynamic ViewBag { get; }
Property Value
Type Description
dynamic

Methods

AddAppendix()

Declaration
public void AddAppendix()

AddBodyText(MultilingualString, bool)

Declaration
public Paragraph AddBodyText(MultilingualString text, bool useMarkdown = true)
Parameters
Type Name Description
MultilingualString text
bool useMarkdown
Returns
Type Description
Paragraph

AddBodyText(string, bool, bool)

Declaration
public Paragraph AddBodyText(string text, bool useMarkdown = true, bool keepWithNext = false)
Parameters
Type Name Description
string text
bool useMarkdown
bool keepWithNext
Returns
Type Description
Paragraph

AddBoldText(string)

Declaration
public Paragraph AddBoldText(string text)
Parameters
Type Name Description
string text
Returns
Type Description
Paragraph

AddCheckBox(string)

Declaration
public void AddCheckBox(string text)
Parameters
Type Name Description
string text

AddCitation(DublinCore, Table)

Declaration
public void AddCitation(DublinCore dublinCore, Table table = null)
Parameters
Type Name Description
DublinCore dublinCore
Table table

AddCodeDomain(CodeDomain, bool)

Declaration
public void AddCodeDomain(CodeDomain codeDomain, bool includeSelectionType = true)
Parameters
Type Name Description
CodeDomain codeDomain
bool includeSelectionType

AddCodeList(CodeList)

Declaration
public void AddCodeList(CodeList codeList)
Parameters
Type Name Description
CodeList codeList

AddCommonGroupInformation(IVersionableGroup)

Declaration
protected void AddCommonGroupInformation(IVersionableGroup group)
Parameters
Type Name Description
IVersionableGroup group

AddCommonStudyInformation(StudyBase)

Declaration
public void AddCommonStudyInformation(StudyBase study)
Parameters
Type Name Description
StudyBase study

AddContent()

Declaration
public virtual void AddContent()

AddCoverage(Coverage, Table)

Declaration
public void AddCoverage(Coverage coverage, Table table)
Parameters
Type Name Description
Coverage coverage
Table table

AddDescriptiveInformation(IVersionable)

Declaration
public void AddDescriptiveInformation(IVersionable item)
Parameters
Type Name Description
IVersionable item

AddFundingInformation(FundingInformation)

Declaration
protected void AddFundingInformation(FundingInformation fundingInfo)
Parameters
Type Name Description
FundingInformation fundingInfo

AddHeader(MultilingualString)

Declaration
public void AddHeader(MultilingualString header)
Parameters
Type Name Description
MultilingualString header

AddHeader(string)

Declaration
public void AddHeader(string text)
Parameters
Type Name Description
string text

AddHeaderWithBackground(string, string)

Declaration
public void AddHeaderWithBackground(string text, string imagePath = null)
Parameters
Type Name Description
string text
string imagePath

AddHeaderWithImage(IVersionable, DisplayLabelType)

Declaration
public void AddHeaderWithImage(IVersionable item, DisplayLabelType displayLabelType = DisplayLabelType.NameAndLabel)
Parameters
Type Name Description
IVersionable item
DisplayLabelType displayLabelType

AddHeaderedText(MultilingualString, MultilingualString)

Declaration
public void AddHeaderedText(MultilingualString header, MultilingualString text)
Parameters
Type Name Description
MultilingualString header
MultilingualString text

AddHeaderedText(string, CodeValue)

Declaration
public void AddHeaderedText(string header, CodeValue cv)
Parameters
Type Name Description
string header
CodeValue cv

AddHeaderedText(string, MultilingualString)

Declaration
public void AddHeaderedText(string header, MultilingualString text)
Parameters
Type Name Description
string header
MultilingualString text

AddHeaderedText(string, string)

Declaration
public void AddHeaderedText(string header, string text)
Parameters
Type Name Description
string header
string text

AddHtml(string)

Declaration
public Paragraph AddHtml(string html)
Parameters
Type Name Description
string html
Returns
Type Description
Paragraph

AddInstrumentSequence(CustomSequenceActivity, bool)

Declaration
public void AddInstrumentSequence(CustomSequenceActivity sequence, bool includeHeader = true)
Parameters
Type Name Description
CustomSequenceActivity sequence
bool includeHeader

AddItem(IVersionable)

Declaration
public void AddItem(IVersionable item)
Parameters
Type Name Description
IVersionable item

AddItemList(IList)

Declaration
public void AddItemList(IList items)
Parameters
Type Name Description
IList items

AddKeyValue(string, CodeValue)

Declaration
public void AddKeyValue(string key, CodeValue value)
Parameters
Type Name Description
string key
CodeValue value

AddKeyValue(string, MultilingualString, bool)

Declaration
public void AddKeyValue(string key, MultilingualString value, bool useMarkdown = true)
Parameters
Type Name Description
string key
MultilingualString value
bool useMarkdown

AddKeyValue(string, VersionableBase)

Declaration
public void AddKeyValue(string key, VersionableBase item)
Parameters
Type Name Description
string key
VersionableBase item

AddKeyValue(string, IList)

Declaration
public void AddKeyValue(string key, IList items)
Parameters
Type Name Description
string key
IList items

AddKeyValue(string, double)

Declaration
public void AddKeyValue(string key, double value)
Parameters
Type Name Description
string key
double value

AddKeyValue(string, double?)

Declaration
public void AddKeyValue(string key, double? value)
Parameters
Type Name Description
string key
double? value

AddKeyValue(string, string, bool, bool)

Declaration
public void AddKeyValue(string key, string value, bool useMarkdown = true, bool includeWithEmptyValue = false)
Parameters
Type Name Description
string key
string value
bool useMarkdown
bool includeWithEmptyValue

AddKeyValueInfoTableRow(string, MultilingualString, Table, bool)

Declaration
public void AddKeyValueInfoTableRow(string key, MultilingualString value, Table table, bool useMarkdown = true)
Parameters
Type Name Description
string key
MultilingualString value
Table table
bool useMarkdown

AddKeyValueInfoTableRow(string, VersionableBase, Table)

Declaration
public void AddKeyValueInfoTableRow(string key, VersionableBase item, Table table)
Parameters
Type Name Description
string key
VersionableBase item
Table table

AddKeyValueInfoTableRow(string, bool, Table)

Declaration
public void AddKeyValueInfoTableRow(string key, bool value, Table table)
Parameters
Type Name Description
string key
bool value
Table table

AddKeyValueInfoTableRow(string, IList, Table)

Declaration
public void AddKeyValueInfoTableRow(string key, IList items, Table table)
Parameters
Type Name Description
string key
IList items
Table table

AddKeyValueInfoTableRow(string, string, Table, bool)

Declaration
public void AddKeyValueInfoTableRow(string key, string value, Table table, bool isFormatted = false)
Parameters
Type Name Description
string key
string value
Table table
bool isFormatted

AddListItem(string, string)

Declaration
public void AddListItem(string text, string target = null)
Parameters
Type Name Description
string text
string target

AddOtherMaterials(IList<OtherMaterial>, string)

Declaration
public void AddOtherMaterials(IList<OtherMaterial> otherMaterials, string header = null)
Parameters
Type Name Description
IList<OtherMaterial> otherMaterials
string header

AddPageBreak()

Declaration
public void AddPageBreak()

AddRadioField(string)

Declaration
public void AddRadioField(string text)
Parameters
Type Name Description
string text

AddReferenceItem(IVersionable)

Declaration
public void AddReferenceItem(IVersionable item)
Parameters
Type Name Description
IVersionable item

AddResponseDomain(ResponseDomain, bool)

Declaration
public void AddResponseDomain(ResponseDomain domain, bool allowCodeScheme = true)
Parameters
Type Name Description
ResponseDomain domain
bool allowCodeScheme

AddRowForKeyValues(Table, string, List<Tuple<string, string>>)

Declaration
public void AddRowForKeyValues(Table table, string title, List<Tuple<string, string>> pairs)
Parameters
Type Name Description
Table table
string title
List<Tuple<string, string>> pairs

AddSingleLevelCodeList(CodeList)

Declaration
public void AddSingleLevelCodeList(CodeList codeList)
Parameters
Type Name Description
CodeList codeList

AddSpacerParagraph()

Declaration
public void AddSpacerParagraph()

AddTextField()

Declaration
public void AddTextField()

AddVersionableInformation(IVersionable, Table)

Declaration
public void AddVersionableInformation(IVersionable item, Table table = null)
Parameters
Type Name Description
IVersionable item
Table table

CreateInfoTable(bool)

Declaration
public Table CreateInfoTable(bool createColumns = true)
Parameters
Type Name Description
bool createColumns
Returns
Type Description
Table

DecreaseHeaderLevel()

Declaration
public string DecreaseHeaderLevel()
Returns
Type Description
string

DecreaseIndentLevel()

Declaration
public string DecreaseIndentLevel()
Returns
Type Description
string

DefineList()

Declaration
public void DefineList()

IncreaseHeaderLevel()

Declaration
public string IncreaseHeaderLevel()
Returns
Type Description
string

IncreaseIndentLevel()

Declaration
public string IncreaseIndentLevel()
Returns
Type Description
string

Log(string)

Declaration
public void Log(string message)
Parameters
Type Name Description
string message

MakeHeaderedCell(Row, int, string, string)

Declaration
public void MakeHeaderedCell(Row row, int cellNumber, string header, string value)
Parameters
Type Name Description
Row row
int cellNumber
string header
string value

TransformAndAddText(Cell, string)

Declaration
public Cell TransformAndAddText(Cell cell, string text)
Parameters
Type Name Description
Cell cell
string text
Returns
Type Description
Cell
In this article
Back to top Generated by DocFX