Skip to content

Update outdated documentation on working with Forms record data. #6563

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 18, 2024
Merged

Update outdated documentation on working with Forms record data. #6563

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1c017c8
Update outdated documentation on working with Forms record data.
AndyButland Oct 17, 2024
0cfeca0
Reverted incorrect update.
AndyButland Oct 17, 2024
c06fc22
Updated 15 version of page
AndyButland Oct 18, 2024
778f598
Minor change to trigger GitBook checks
sofietoft Oct 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions 10/umbraco-forms/developer/working-with-data.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,15 @@ Returns all records with the state set to approved from all Forms on the Umbraco
### GetApprovedRecordsFromFormOnPage

```csharp
PagedResult<IRecord> GetApprovedRecordsFromFormOnPage(int pageId, Guid.Parse("formId"), int pageNumber, int pageSize)
PagedResult<IRecord> GetApprovedRecordsFromFormOnPage(int pageId, Guid 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<IRecord>`.

### GetApprovedRecordsFromForm

```csharp
PagedResult<IRecord> GetApprovedRecordsFromForm(Guid.Parse("formId"), int pageNumber, int pageSize)
PagedResult<IRecord> GetApprovedRecordsFromForm(Guid formId, int pageNumber, int pageSize)
```

Returns all records with the state set to approved from the Form with the ID = `formId` as a `PagedResult<IRecord>`.
Expand All @@ -46,15 +46,15 @@ Returns all records from all Forms on the Umbraco page with the id = `pageId` as
### GetRecordsFromFormOnPage

```csharp
PagedResult<IRecord> GetRecordsFromFormOnPage(int pageId, Guid.Parse("formId"), int pageNumber, int pageSize)
PagedResult<IRecord> GetRecordsFromFormOnPage(int pageId, Guid 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<IRecord>`.

### GetRecordsFromForm

```csharp
PagedResult<IRecord> GetRecordsFromForm(Guid.Parse("formId"), int pageNumber, int pageSize)
PagedResult<IRecord> GetRecordsFromForm(Guid formId, int pageNumber, int pageSize)
```

Returns all records from the Form with the ID = formId as a `PagedResult<IRecord>`.
Expand Down
26 changes: 13 additions & 13 deletions 13/umbraco-forms/developer/working-with-data.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,56 +13,56 @@ The methods can be found by injecting the `Umbraco.Forms.Core.Services.IRecordRe
### GetApprovedRecordsFromPage

```csharp
PagedResult<IRecord> GetApprovedRecordsFromPage(int pageId, int pageNumber, int pageSize)
PagedResult<Record> 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

```csharp
PagedResult<IRecord> GetApprovedRecordsFromFormOnPage(int pageId, Guid.Parse("formId"), int pageNumber, int pageSize)
PagedResult<Record> GetApprovedRecordsFromFormOnPage(int pageId, Guid 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<IRecord>`.
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<Record>`.

### GetApprovedRecordsFromForm

```csharp
PagedResult<IRecord> GetApprovedRecordsFromForm(Guid.Parse("formId"), int pageNumber, int pageSize)
PagedResult<Record> GetApprovedRecordsFromForm(Guid formId, int pageNumber, int pageSize)
```

Returns all records with the state set to approved from the Form with the ID = `formId` as a `PagedResult<IRecord>`.
Returns all records with the state set to approved from the Form with the ID = `formId` as a `PagedResult<Record>`.

### GetRecordsFromPage

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

Returns all records from all Forms on the Umbraco page with the id = `pageId` as a `PagedResult<IRecord>`.
Returns all records from all Forms on the Umbraco page with the id = `pageId` as a `PagedResult<Record>`.

### GetRecordsFromFormOnPage

```csharp
PagedResult<IRecord> GetRecordsFromFormOnPage(int pageId, Guid.Parse("formId"), int pageNumber, int pageSize)
PagedResult<Record> GetRecordsFromFormOnPage(int pageId, Guid 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<IRecord>`.
Returns all records from the Form with the id = `formId` on the Umbraco page with the id = `pageId` as a `PagedResult<Record>`.

### GetRecordsFromForm

```csharp
PagedResult<IRecord> GetRecordsFromForm(Guid.Parse("formId"), int pageNumber, int pageSize)
PagedResult<Record> GetRecordsFromForm(Guid formId, int pageNumber, int pageSize)
```

Returns all records from the Form with the ID = formId as a `PagedResult<IRecord>`.
Returns all records from the Form with the ID = formId as a `PagedResult<Record>`.

## The returned objects

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

The properties available on a `IRecord` are:
The properties available on a `Record` are:

```csharp
int Id
Expand Down
26 changes: 13 additions & 13 deletions 14/umbraco-forms/developer/working-with-data.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,56 +13,56 @@ The methods can be found by injecting the `Umbraco.Forms.Core.Services.IRecordRe
### GetApprovedRecordsFromPage

```csharp
PagedResult<IRecord> GetApprovedRecordsFromPage(int pageId, int pageNumber, int pageSize)
PagedResult<Record> 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

```csharp
PagedResult<IRecord> GetApprovedRecordsFromFormOnPage(int pageId, Guid.Parse("formId"), int pageNumber, int pageSize)
PagedResult<Record> GetApprovedRecordsFromFormOnPage(int pageId, Guid 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<IRecord>`.
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<Record>`.

### GetApprovedRecordsFromForm

```csharp
PagedResult<IRecord> GetApprovedRecordsFromForm(Guid.Parse("formId"), int pageNumber, int pageSize)
PagedResult<Record> GetApprovedRecordsFromForm(Guid formId, int pageNumber, int pageSize)
```

Returns all records with the state set to approved from the Form with the ID = `formId` as a `PagedResult<IRecord>`.
Returns all records with the state set to approved from the Form with the ID = `formId` as a `PagedResult<Record>`.

### GetRecordsFromPage

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

Returns all records from all Forms on the Umbraco page with the id = `pageId` as a `PagedResult<IRecord>`.
Returns all records from all Forms on the Umbraco page with the id = `pageId` as a `PagedResult<Record>`.

### GetRecordsFromFormOnPage

```csharp
PagedResult<IRecord> GetRecordsFromFormOnPage(int pageId, Guid.Parse("formId"), int pageNumber, int pageSize)
PagedResult<Record> GetRecordsFromFormOnPage(int pageId, Guid 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<IRecord>`.
Returns all records from the Form with the id = `formId` on the Umbraco page with the id = `pageId` as a `PagedResult<Record>`.

### GetRecordsFromForm

```csharp
PagedResult<IRecord> GetRecordsFromForm(Guid.Parse("formId"), int pageNumber, int pageSize)
PagedResult<Record> GetRecordsFromForm(Guid formId, int pageNumber, int pageSize)
```

Returns all records from the Form with the ID = formId as a `PagedResult<IRecord>`.
Returns all records from the Form with the ID = formId as a `PagedResult<Record>`.

## The returned objects

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

The properties available on a `IRecord` are:
The properties available on a `Record` are:

```csharp
int Id
Expand Down
Loading