Working with Record data

    From Umbraco Forms v8.2 includes some helper methods that return records of a given form, which can be used to output records in your templates using razor.

    Available methods

    The methods can be found by injecting the Umbraco.Forms.Core.Services.IRecordReaderService interface. For performance reasons, all these methods are paged.

    GetApprovedRecordsFromPage

    PagedResult<IRecord> GetApprovedRecordsFromPage(int pageId, int pageNumber, int pageSize)
    

    Returns all records with the state set to approved from all forms on the Umbraco page with the id = pageId .

    GetApprovedRecordsFromFormOnPage

    PagedResult<IRecord> GetApprovedRecordsFromFormOnPage(int pageId, string formId, int pageNumber, int pageSize)
    

    Returns all records with the state set to approved from the form with the id = formId on the Umbraco page with the id = pageId as a PagedResult.

    GetApprovedRecordsFromForm

    PagedResult<IRecord> GetApprovedRecordsFromForm(string formId, int pageNumber, int pageSize)
    

    Returns all records with the state set to approved from the form with the ID = formId as a PagedResult.

    GetRecordsFromPage

    PagedResult<IRecord> GetRecordsFromPage(int pageId, int pageNumber, int pageSize)
    

    Returns all records from all forms on the Umbraco page with the id = pageId as a PagedResult.

    GetRecordsFromFormOnPage

    PagedResult<IRecord> GetRecordsFromFormOnPage(int pageId, string formId, int pageNumber, int pageSize)
    

    Returns all records from the form with the id = formId on the Umbraco page with the id = pageId as a PagedResult.

    GetRecordsFromForm

    PagedResult<IRecord> GetRecordsFromForm(string formId, int pageNumber, int pageSize)
    

    Returns all records from the form with the ID = formId as a PagedResult

    The returned objects

    All of these methods will return an object of type PagedResult<IRecord> so you can iterate through the IRecord objects.

    The properties available on a IRecord are:

    int Id
    FormState State
    DateTime Created
    DateTime Updated
    Guid Form
    string IP
    int UmbracoPageId
    string MemberKey
    Guid UniqueId
    Dictionary<Guid, RecordField> RecordFields
    

    In order to access custom form fields, these are available in the RecordFields property. Furthermore there exists an extension method named ValueAsString on IRecord in Umbraco.Forms.Core.Services, such that you can get the value as string given the alias of the field.

    This extension method handle multi value fields by comma separating the values. E.g. "A, B, C"

    Sample razor script

    Sample script that is outputting comments using a form created with the default comment form template.

    @using Umbraco.Core;
    @using Umbraco.Core.Composing
    @using Umbraco.Forms.Core.Services
    @{
        var recordReaderService = Current.Factory.GetInstance<IRecordReaderService>();
    }
    <ul id="comments">
        @foreach (var record in recordReaderService.GetApprovedRecordsFromPage(Model.Id, 0, 10).Items)
        {
        <li>
            @record.Created.ToString("dd MMMM yyy")
            @if(string.IsNullOrEmpty(record.ValueAsString("email")){
                <strong>@record.ValueAsString("name")</strong>
            }
            else{
                <strong>
                    <a href="mailto:@record.ValueAsString("email")" target="_blank">@record.ValueAsString("name")</a>
                </strong>
            }
            <span>said</span>
            <p>@record.ValueAsString("comment")</p>
        </li>
        }
    </ul>