Skip to content

Commit

Permalink
Update documentation for bound property changes
Browse files Browse the repository at this point in the history
  • Loading branch information
daviddotcs committed Apr 18, 2022
1 parent 9614049 commit 18a2af5
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ public static IndexRouteInfo Index(string standard, string fromQuery, string fro
}
```

Properties on the controller or page model class which are annotated with `[FromRoute]` attributes are automatically included in the signatures of all generated methods for that class. This ensures that all route values necessary for constructing a URL are provided when calling the methods. E.g; consider the following razor page model:
Properties on the controller or page model class which are annotated with `[FromRoute]`, `[FromQuery]`, or `[BindProperty(SupportsGet = true)]` attributes, and properties within a class annotated with `[BindProperties(SupportsGet = true)]` are automatically included in the signatures of all generated methods for that class. This ensures that all route values necessary for constructing a URL are provided when calling the methods. E.g; consider the following razor page model:

```csharp
public sealed class EditModel : PageModel
Expand Down Expand Up @@ -265,10 +265,10 @@ safe_routing.generated_namespace = Example.Namespace.Routes

### Available Configuration Options

| Option | Description |
|------------------------------------------|----------------------------------------------------------------------------------------------------------|
| Option | Description |
|--------|-------------|
| `safe_routing.generated_access_modifier` | The access modifier used for all generated classes. Can be _public_ or _internal_. Defaults to _public_. |
| `safe_routing.generated_namespace` | The namespace under which all generated route classes are created. Defaults to _Routes_. |
| `safe_routing.generated_namespace` | The namespace under which all generated route classes are created. Defaults to _Routes_. |

## Limitations

Expand Down
8 changes: 4 additions & 4 deletions src/README.source.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ public static IndexRouteInfo Index(string standard, string fromQuery, string fro
}
```

Properties on the controller or page model class which are annotated with `[FromRoute]` attributes are automatically included in the signatures of all generated methods for that class. This ensures that all route values necessary for constructing a URL are provided when calling the methods. E.g; consider the following razor page model:
Properties on the controller or page model class which are annotated with `[FromRoute]`, `[FromQuery]`, or `[BindProperty(SupportsGet = true)]` attributes, and properties within a class annotated with `[BindProperties(SupportsGet = true)]` are automatically included in the signatures of all generated methods for that class. This ensures that all route values necessary for constructing a URL are provided when calling the methods. E.g; consider the following razor page model:

```csharp
public sealed class EditModel : PageModel
Expand Down Expand Up @@ -245,10 +245,10 @@ safe_routing.generated_namespace = Example.Namespace.Routes

### Available Configuration Options

| Option | Description |
|------------------------------------------|----------------------------------------------------------------------------------------------------------|
| Option | Description |
|--------|-------------|
| `safe_routing.generated_access_modifier` | The access modifier used for all generated classes. Can be _public_ or _internal_. Defaults to _public_. |
| `safe_routing.generated_namespace` | The namespace under which all generated route classes are created. Defaults to _Routes_. |
| `safe_routing.generated_namespace` | The namespace under which all generated route classes are created. Defaults to _Routes_. |

## Limitations

Expand Down

0 comments on commit 18a2af5

Please sign in to comment.