Interface IArcherContentEdit

Allows a content record's field values to be edited and thereafter persisted back to Archer via a call to IContentResolver.Update().

Inherited Members
Namespace: Estrelica.Archer.Content
Assembly: Estrelica.Interfaces.dll
Syntax
[StayPublic]
[DoNotObfuscateType]
public interface IArcherContentEdit : IArcherRecord, IRecordAccess<int>, IRecordAccess, ISystemUpdateable, IEditable
Remarks

Supported editable field types are ITextField, IDateField, INumericField, IAttachmentField, IImageField, IValuesListField, IIPAddressField, ICrossReferenceField, IRelatedRecordsField, ISubformField and IUserGroupListField

Properties

RequiredFields

Returns an IEnumerable of all of the fields that are configured as "Required"

Declaration
IEnumerable<IArcherField> RequiredFields { get; }
Property Value
IEnumerable<IArcherField>

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

SubformFieldId

Declaration
int? SubformFieldId { get; }
Property Value
int?

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

Methods

AttachmentField(Guid)

Declaration
IDocumentSelectionEdit AttachmentField(Guid attachmentFieldGuid)
Parameters
Guid attachmentFieldGuid

Returns
IDocumentSelectionEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

AttachmentField(int)

Declaration
IDocumentSelectionEdit AttachmentField(int attachmentFieldId)
Parameters
int attachmentFieldId

Returns
IDocumentSelectionEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

AttachmentField(string)

Declaration
IDocumentSelectionEdit AttachmentField(string attachmentFieldNameOrAlias)
Parameters
string attachmentFieldNameOrAlias

Returns
IDocumentSelectionEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

CrossReferenceField(Guid)

Declaration
ICrossReferencedRecordsSelectionEdit CrossReferenceField(Guid crossReferenceFieldGuid)
Parameters
Guid crossReferenceFieldGuid

Returns
ICrossReferencedRecordsSelectionEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

CrossReferenceField(int)

Declaration
ICrossReferencedRecordsSelectionEdit CrossReferenceField(int crossReferenceFieldId)
Parameters
int crossReferenceFieldId

Returns
ICrossReferencedRecordsSelectionEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

CrossReferenceField(string)

Declaration
ICrossReferencedRecordsSelectionEdit CrossReferenceField(string crossReferenceFieldNameOrAlias)
Parameters
string crossReferenceFieldNameOrAlias

Returns
ICrossReferencedRecordsSelectionEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

DateField(Guid)

Declaration
IDateValueEdit DateField(Guid dateFieldGuid)
Parameters
Guid dateFieldGuid

Returns
IDateValueEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

DateField(int)

Declaration
IDateValueEdit DateField(int dateFieldId)
Parameters
int dateFieldId

Returns
IDateValueEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

DateField(string)

Declaration
IDateValueEdit DateField(string datefieldNameOrAlias)
Parameters
string datefieldNameOrAlias

Returns
IDateValueEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

DocumentField(Guid)

Declaration
IDocumentSelectionEdit DocumentField(Guid documentFieldGuid)
Parameters
Guid documentFieldGuid

Returns
IDocumentSelectionEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

DocumentField(int)

Declaration
IDocumentSelectionEdit DocumentField(int documentFieldId)
Parameters
int documentFieldId

Returns
IDocumentSelectionEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

DocumentField(string)

Declaration
IDocumentSelectionEdit DocumentField(string documentFieldNameOrAlias)
Parameters
string documentFieldNameOrAlias

Returns
IDocumentSelectionEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

ExternalLinksField(Guid)

Declaration
IExternalLinksSelectionEdit ExternalLinksField(Guid externalLinksFieldNameGuid)
Parameters
Guid externalLinksFieldNameGuid

Returns
IExternalLinksSelectionEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

ExternalLinksField(int)

Declaration
IExternalLinksSelectionEdit ExternalLinksField(int externalLinksFieldId)
Parameters
int externalLinksFieldId

Returns
IExternalLinksSelectionEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

ExternalLinksField(string)

Declaration
IExternalLinksSelectionEdit ExternalLinksField(string externalLinksFieldNameOrAlias)
Parameters
string externalLinksFieldNameOrAlias

Returns
IExternalLinksSelectionEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

Field(IArcherField)

Returns an editor for the given field, if the field is editable, or the current value of the field if not.

Declaration
object Field(IArcherField field)
Parameters
IArcherField field

Returns
object

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

Field(ICrossReferenceField)

Declaration
ICrossReferencedRecordsSelectionEdit Field(ICrossReferenceField referenceField)
Parameters
ICrossReferenceField referenceField

Returns
ICrossReferencedRecordsSelectionEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

Field(IDateField)

Declaration
IDateValueEdit Field(IDateField dateField)
Parameters
IDateField dateField

Returns
IDateValueEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

Field(IDocumentField)

Declaration
IDocumentSelectionEdit Field(IDocumentField documentField)
Parameters
IDocumentField documentField

Returns
IDocumentSelectionEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

Field(IExternalLinksField)

Declaration
IExternalLinksSelectionEdit Field(IExternalLinksField externalLinksField)
Parameters
IExternalLinksField externalLinksField

Returns
IExternalLinksSelectionEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

Field(IIPAddressField)

Declaration
ITextValueEdit Field(IIPAddressField ipAddressField)
Parameters
IIPAddressField ipAddressField

Returns
ITextValueEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

Field(INumericField)

Declaration
INumericValueEdit Field(INumericField numericField)
Parameters
INumericField numericField

Returns
INumericValueEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

Field(IRelatedRecordsField)

Declaration
IReferencedRecordsSelectionEdit Field(IRelatedRecordsField referenceField)
Parameters
IRelatedRecordsField referenceField

Returns
IReferencedRecordsSelectionEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

Field(ISubformField)

Declaration
IReferencedRecordsSelectionEdit Field(ISubformField referenceField)
Parameters
ISubformField referenceField

Returns
IReferencedRecordsSelectionEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

Field(ITextField)

Declaration
ITextValueEdit Field(ITextField textField)
Parameters
ITextField textField

Returns
ITextValueEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

Field(IUserGroupListField)

Declaration
IUserGroupListSelectionEdit Field(IUserGroupListField userGroupField)
Parameters
IUserGroupListField userGroupField

Returns
IUserGroupListSelectionEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

Field(IValuesListField)

Returns an IValuesListSelectionEdit editor for the provided IValuesListField of the current record if the field is editable, otherwise raises an exception

Declaration
IValuesListSelectionEdit Field(IValuesListField valueListField)
Parameters
IValuesListField valueListField

Returns
IValuesListSelectionEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

GetErrors()

Returns an IEnumerable of Tuples indicating any errors that may exist in the edited record, and the fields on which they were found.

Declaration
IEnumerable<Tuple<IArcherField, IEnumerable<string>>> GetErrors()
Returns
IEnumerable<Tuple<IArcherField, IEnumerable<string>>>

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

IPAddressField(Guid)

Declaration
ITextValueEdit IPAddressField(Guid ipAddressFieldGuid)
Parameters
Guid ipAddressFieldGuid

Returns
ITextValueEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

IPAddressField(int)

Declaration
ITextValueEdit IPAddressField(int ipAddressFieldId)
Parameters
int ipAddressFieldId

Returns
ITextValueEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

IPAddressField(string)

Declaration
ITextValueEdit IPAddressField(string ipAddressFieldNameOrAlias)
Parameters
string ipAddressFieldNameOrAlias

Returns
ITextValueEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

ImageField(Guid)

Declaration
IDocumentSelectionEdit ImageField(Guid imageFieldGuid)
Parameters
Guid imageFieldGuid

Returns
IDocumentSelectionEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

ImageField(int)

Declaration
IDocumentSelectionEdit ImageField(int imageFieldId)
Parameters
int imageFieldId

Returns
IDocumentSelectionEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

ImageField(string)

Declaration
IDocumentSelectionEdit ImageField(string imageFieldNameOrAlias)
Parameters
string imageFieldNameOrAlias

Returns
IDocumentSelectionEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

NumericField(Guid)

Declaration
INumericValueEdit NumericField(Guid numericFieldGuid)
Parameters
Guid numericFieldGuid

Returns
INumericValueEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

NumericField(int)

Declaration
INumericValueEdit NumericField(int numericFieldId)
Parameters
int numericFieldId

Returns
INumericValueEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

NumericField(string)

Declaration
INumericValueEdit NumericField(string numericFieldNameOrAlias)
Parameters
string numericFieldNameOrAlias

Returns
INumericValueEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

RelatedRecordsField(Guid)

Declaration
IReferencedRecordsSelectionEdit RelatedRecordsField(Guid relatedRecordsFieldGuid)
Parameters
Guid relatedRecordsFieldGuid

Returns
IReferencedRecordsSelectionEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

RelatedRecordsField(int)

Declaration
IReferencedRecordsSelectionEdit RelatedRecordsField(int relatedRecordsFieldId)
Parameters
int relatedRecordsFieldId

Returns
IReferencedRecordsSelectionEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

RelatedRecordsField(string)

Declaration
IReferencedRecordsSelectionEdit RelatedRecordsField(string relatedRecordsFieldNameOrAlias)
Parameters
string relatedRecordsFieldNameOrAlias

Returns
IReferencedRecordsSelectionEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

Reload(ContentSource?)

Reloads the current record from Archer, returning it in a new IArcherContent result. This is intended to be called after the current record has been persisted via a call to IContentResolver.Update(), for purposes of reading back the persisted results for any followup validation/confirmation that may be needed.

Declaration
IArcherContentAccess Reload(ContentSource? contentSource = null)
Parameters
ContentSource? contentSource

Returns
IArcherContentAccess

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

SaveChanges()

Persists any changes made to the record (i.e. saves the changes to Archer).

Declaration
int SaveChanges()
Returns
int

0 if no changes have been made to the record (and therefore nothing can be persisted), otherwise the content Id of the persisted record.
Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

SubformField(Guid)

Declaration
IReferencedRecordsSelectionEdit SubformField(Guid subformFieldGuid)
Parameters
Guid subformFieldGuid

Returns
IReferencedRecordsSelectionEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

SubformField(int)

Declaration
IReferencedRecordsSelectionEdit SubformField(int subformFieldId)
Parameters
int subformFieldId

Returns
IReferencedRecordsSelectionEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

SubformField(string)

Declaration
IReferencedRecordsSelectionEdit SubformField(string subformFieldNameOrAlias)
Parameters
string subformFieldNameOrAlias

Returns
IReferencedRecordsSelectionEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

TextField(Guid)

Declaration
ITextValueEdit TextField(Guid textFieldGuid)
Parameters
Guid textFieldGuid

Returns
ITextValueEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

TextField(int)

Declaration
ITextValueEdit TextField(int textFieldId)
Parameters
int textFieldId

Returns
ITextValueEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

TextField(string)

Declaration
ITextValueEdit TextField(string textFieldNameOrAlias)
Parameters
string textFieldNameOrAlias

Returns
ITextValueEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

UserGroupField(Guid)

Declaration
IUserGroupListSelectionEdit UserGroupField(Guid userGroupFieldGuid)
Parameters
Guid userGroupFieldGuid

Returns
IUserGroupListSelectionEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

UserGroupField(int)

Declaration
IUserGroupListSelectionEdit UserGroupField(int userGroupFieldId)
Parameters
int userGroupFieldId

Returns
IUserGroupListSelectionEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

UserGroupField(string)

Declaration
IUserGroupListSelectionEdit UserGroupField(string userGroupFieldNameOrAlias)
Parameters
string userGroupFieldNameOrAlias

Returns
IUserGroupListSelectionEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

ValuesListField(Guid)

Declaration
IValuesListSelectionEdit ValuesListField(Guid valuesListFieldGuid)
Parameters
Guid valuesListFieldGuid

Returns
IValuesListSelectionEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

ValuesListField(int)

Declaration
IValuesListSelectionEdit ValuesListField(int valuesListFieldId)
Parameters
int valuesListFieldId

Returns
IValuesListSelectionEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

ValuesListField(string)

Declaration
IValuesListSelectionEdit ValuesListField(string valuesListFieldNameOrAlias)
Parameters
string valuesListFieldNameOrAlias

Returns
IValuesListSelectionEdit

Exceptions
InvalidOperationException

An InvalidOperationException will be raised if any edit method is called on a calculated field or a field that is otherwise configured as read-only.

Extension Methods