relation-scaffolding

KO | EN

gitlite — search

#python #hacktoberfest #llm #go #machine-learning #rust #deep-learning #java #windows #awesome #awesome-list #pytorch #mcp #ios

relation-scaffolding

(★ 9)

Relation dependencies in EntityFramework is common taks. This package will create a select box, or checkboxes depending if you have a One2One or One2Many relationship.

relation-scaffolding 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

relation-scaffolding
====================

Relation dependencies in EntityFramework is common task.
This package will create a select box, or checkboxes depending if you have a Single or Multiple relationship.

This package hooks up with MVC5.

# Installation
Run the following command
```
Install-Package RelationScaffolding
```

The current package does not setup everything automatically. Please keep reading to understand
what has to be done manually to use this package.

The package will install the following:
 * DLL reference
 * Templates in /Views/Shared/[EditorTemplates|DisplayTemplates]
   * Feel free to modify those templates to your needs, note that this project is in beta and those files will most likely be updated later
   * If you use this inside an Area, you do not need to move these files. They will be picked up automatically.
 * One JavaScript file /Scripts/relation.js

## Manual Steps
Install the JavaScript in your bundles

BundleConfig.cs
```c#
bundles.Add(new ScriptBundle("~/bundles/relation").Include(
            "~/Scripts/relation.js"));
```

_Layout.cshtml
```cshtml
@Scripts.Render("~/bundles/relation")
```

# Usage
After everything is setup, you can name your property that you want to get a relation displayed.

## Classes
```c#
public class Book
{
    [Key]
    public long Id { get; set; }

[Required]
    public string Name { get; set; }

[RelationScaffolding.RelationSingle(Empty = "Select an author")]
    public Member Author { get; set; }

[RelationScaffolding.RelationMultiple]
    public virtual ICollection<Member> Followers { get; set; }
}
```

On the Member class, you have to mention which property is the key, and which one you want to display.
```c#
public class Member
{
    [Key]
    public long Id { get; set; }

[Required]
    [RelationScaffolding.RelationDisplay]
    public string Name { get; set; }
}
```

If you do not set the `[Key]` attribute, we try to find a property that ends with `Id`.

Definition of the attributes:

1. `RelationSingle`: will display a single property in display mode or a combo box in edit mode. Use the `Empty` option to pre-fill the combo box with a default string value.
2. `RelationMultiple`: will display an unordered list in display mode or an unordered checkbox list in edit mode. Use the `CanAdd` option to add a textbox allowing addition to the list. Use the `Many2Many` option to tell that the collection is a joint table.
3. `Relation`: will use the `RelationMultiple` or `RelationSingle` accordingly if the property is an array or not.
4. `RelationDisplay`: indicates which property to use when displayed in `RelationSingle` or `RelationMultiple`. You can combine this attribute with the attribute [NotMapped] if you want to add a computed property.
5. `RelationEdit`: indicates which property will be used when using the `CanAdd` from `RelationMultiple`.
6. `RelationList`: indicates which property will be used as a list for a Many2Many joint table. Use the "PropertyNameList" in your cshtml to populate the whole list of item.

## View
The current scaffolding is not automatically populating the view for relations.
Use the same code as a primite would use to generate relations.

Use something like this:
```cshtml
@Html.EditorFor(model => model.Author, new { htmlAttributes = new { @class = "form-control" } })
```

If you are dealing with a `Multiple`, you probably want to get the whole list of items. Use the following:
```cshtml
@Html.EditorFor(model => model.Followers, new { list = ViewBag.AllMembers, htmlAttributes = new { @class = "form-control" } })
```

If you are using `Many2Many`, you can assign the list to the variable name "`FieldName`List".
```cshtml
@Html.EditorFor(model => model.Followers, new { PersonList = ViewBag.AllMembers, htmlAttributes = new { @class = "form-control" } })
```

In your controller:
```c#
ViewBag.AllMembers = dbContext.Members.ToList();
```

## Controller Model Binding
I am actively working on this.

Roadmap
-------
 * Model Binder
 * Make "CanAdd" more generic
 * Support Many 2 Many
 * Add a new Scaffolding template T4
 * Better support of styles
 * I18n
 * Unit Tests

relation-scaffolding

relation-scaffolding 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

relation-scaffolding

relation-scaffolding 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README