Class Input

Inheritance

System.Object

Input

ItemPickerInput

LabelOnlyInput

MultiLineTextInput

NumberEntryInput

QrCodeInput

SingleLineTextInput

SliderInput

VoiceInput

Implements

System.ComponentModel.INotifyPropertyChanged

Namespace: Sensus.UI.Inputs

Assembly: SensusAndroid.dll

Syntax

public abstract class Input : Object, INotifyPropertyChanged

Constructors

Input()

Declaration

public Input()

Input(String)

Declaration

public Input(string labelText)

Parameters

Type	Name	Description
System.String	labelText

Input(String, Int32)

Declaration

public Input(string labelText, int labelFontSize)

Parameters

Type	Name	Description
System.String	labelText
System.Int32	labelFontSize

Input(String, String)

Declaration

public Input(string labelText, string name)

Parameters

Type	Name	Description
System.String	labelText
System.String	name

Fields

EFFECT_RESOLUTION_GROUP_NAME

Declaration

public const string EFFECT_RESOLUTION_GROUP_NAME = "InputEffects"

Field Value

Type	Description
System.String

Properties

BackgroundColor

Declaration

public Nullable<Color> BackgroundColor { get; set; }

Property Value

Type	Description
System.Nullable<Xamarin.Forms.Color>

Caption

Declaration

public string Caption { get; }

Property Value

Type	Description
System.String

Complete

Gets or sets a value indicating whether the user has interacted with this Input, leaving it in a state of completion. Contrast with Valid, which merely indicates that the state of the input will not prevent the user from moving through an input request (e.g., in the case of inputs that are not required).

Declaration

public bool Complete { get; protected set; }

Property Value

Type	Description
System.Boolean	true if complete; otherwise, false.

CompletionRecords

Declaration

public List<InputCompletionRecord> CompletionRecords { get; }

Property Value

Type	Description
System.Collections.Generic.List<InputCompletionRecord>

CompletionTimestamp

Declaration

public Nullable<DateTimeOffset> CompletionTimestamp { get; }

Property Value

Type	Description
System.Nullable<System.DateTimeOffset>

DefaultName

Declaration

public abstract string DefaultName { get; }

Property Value

Type	Description
System.String

Display

Declaration

public bool Display { get; }

Property Value

Type	Description
System.Boolean

DisplayConditions

Declaration

public List<InputDisplayCondition> DisplayConditions { get; }

Property Value

Type	Description
System.Collections.Generic.List<InputDisplayCondition>

DisplayNumber

Declaration

public bool DisplayNumber { get; set; }

Property Value

Type	Description
System.Boolean

Enabled

Declaration

public abstract bool Enabled { get; set; }

Property Value

Type	Description
System.Boolean

Frame

Declaration

public bool Frame { get; set; }

Property Value

Type	Description
System.Boolean

GroupId

Declaration

public string GroupId { get; set; }

Property Value

Type	Description
System.String

Id

Declaration

public string Id { get; set; }

Property Value

Type	Description
System.String

LabelFontSize

Declaration

public int LabelFontSize { get; set; }

Property Value

Type	Description
System.Int32

LabelText

The text to display next to the input when showing the field to the user for completion. If you would like to use the value of a survey-triggering CurrentDatum within the input's label, you can do so by placing a {0} within LabelText as a placeholder. The placeholder will be replaced with the value of the triggering Datum at runtime. You can read more about the format of the placeholder here.

Declaration

[EntryStringUiProperty("Label Text:", true, 1, true)]
public string LabelText { get; set; }

Property Value

Type	Description
System.String	The label text.

Latitude

Declaration

public Nullable<double> Latitude { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>

LocationUpdateTimestamp

Declaration

public Nullable<DateTimeOffset> LocationUpdateTimestamp { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTimeOffset>

Longitude

Declaration

public Nullable<double> Longitude { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>

Name

The name by which this input will be referred to within the Sensus app.

Declaration

[EntryStringUiProperty("Name:", true, 0, true)]
public string Name { get; set; }

Property Value

Type	Description
System.String	The name.

Padding

Declaration

public Nullable<Thickness> Padding { get; set; }

Property Value

Type	Description
System.Nullable<Xamarin.Forms.Thickness>

Required

Whether or not a valid value is required for this input. Also see ForceValidInputs.

Declaration

[OnOffUiProperty(null, true, 5)]
public bool Required { get; set; }

Property Value

Type	Description
System.Boolean	true if required; otherwise, false.

Store

Gets a value indicating whether this Input should be stored in the System.LocalDataStore.

Declaration

public virtual bool Store { get; }

Property Value

Type	Description
System.Boolean	true if store; otherwise, false.

StoreCompletionRecords

Whether or not to record a trace of all input values from the first to the final.

Declaration

[OnOffUiProperty("Store Completion Records:", true, 6)]
public bool StoreCompletionRecords { get; set; }

Property Value

Type	Description
System.Boolean	true if store completion records; otherwise, false.

SubmissionTimestamp

Declaration

public Nullable<DateTimeOffset> SubmissionTimestamp { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTimeOffset>

TriggeringDatum

Gets or sets the Datum that triggered the deployment of this Input. This is what will be used when formatting placeholder text in the input LabelText.

Declaration

public Datum TriggeringDatum { get; set; }

Property Value

Type	Description
Datum	The triggering datum.

Valid

Gets a value indicating whether this Input is valid. A valid Input is one that is complete, one that has been viewed but is not required, or one that isn't displayed. It is an Input in a state that should not prevent the user from proceeding through an Input request.

Declaration

public bool Valid { get; }

Property Value

Type	Description
System.Boolean	true if valid; otherwise, false.

Value

Declaration

public abstract object Value { get; }

Property Value

Type	Description
System.Object

Viewed

Declaration

public bool Viewed { get; set; }

Property Value

Type	Description
System.Boolean

Methods

Copy(Boolean)

Declaration

public Input Copy(bool newId)

Parameters

Type	Name	Description
System.Boolean	newId

Returns

Type	Description
Input

CreateLabel(Int32)

Declaration

protected Label CreateLabel(int index)

Parameters

Type	Name	Description
System.Int32	index

Returns

Type	Description
Xamarin.Forms.Label

GetLabelText(Int32)

Declaration

protected string GetLabelText(int index)

Parameters

Type	Name	Description
System.Int32	index

Returns

Type	Description
System.String

GetView(Int32)

Declaration

public virtual View GetView(int index)

Parameters

Type	Name	Description
System.Int32	index

Returns

Type	Description
Xamarin.Forms.View

Reset()

Declaration

public void Reset()

SetView(View)

Declaration

protected virtual void SetView(View value)

Parameters

Type	Name	Description
Xamarin.Forms.View	value

ToString()

Returns a System.String that represents the current Input. This is needed when adding display conditions.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A System.String that represents the current Input.

ValueMatches(Object, Boolean)

Declaration

public virtual bool ValueMatches(object conditionValue, bool conjunctive)

Parameters

Type	Name	Description
System.Object	conditionValue
System.Boolean	conjunctive

Returns

Type	Description
System.Boolean

Events

PropertyChanged

Declaration

public event PropertyChangedEventHandler PropertyChanged

Event Type

Type	Description
System.ComponentModel.PropertyChangedEventHandler

Implements

System.ComponentModel.INotifyPropertyChanged