Skip to content
This repository has been archived by the owner on Nov 21, 2024. It is now read-only.

Commit

Permalink
Merge branch 'dev'
Browse files Browse the repository at this point in the history
  • Loading branch information
hikalkan committed Apr 21, 2020
2 parents 110e331 + 577f1a9 commit dbb7967
Show file tree
Hide file tree
Showing 21 changed files with 767 additions and 77 deletions.
Binary file added en/Images/user-action-extension-click-me-ng.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
53 changes: 53 additions & 0 deletions en/abp-suite/generating-crud-page.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,59 @@ You can use sorting field column to specify or change the order in which results

![Property list](../images/suite-list-properties.png)

## Navigation Properties

A **navigation property** is an optional **property** on an entity type that allows for **navigation** from one end of an association to the other end. Unlike other properties, **navigation properties** do not carry data.

Here's a navigation property example; The `student` entity holds a foreign key to the `teacher` entity which stores the primary key of the `teacher` entity.

![Navigation property example](../images/suite-entity-with-navigation-property.png)

#### How to define a navigation property?

* **Entity namespace**: Namespace of the **target entity** you want to use as the navigation property.
* Example:`SampleMongoSchoolApp.Teachers`
* **Entity name**: Name of the **target entity**.
* Example: `Teacher`
* **Entity collection name**: Collection name of the **target entity** in `DbContext`.
* Example: `Teachers`
* **DTO namespace**: Namespace of DTO object of the entity.
* Example:`SampleMongoSchoolApp.Teachers`
* **DTO name**: Name of the DTO object of the **target entity**.
* Example:`TeacherDto`
* **Primary key**: Primary key type of the **target entity**.
* Example: `Guid`
* **Property name**: Name of the (reference) property that will be created in the main entity.
* Example: `TeacherId`
* **Display property**: Property name of the target entity which you want to show as display text. It must be a string property.
* Example: `Name`
* **UI pick type**: Determinates how to set the navigation value.
* **Modal**: In a modal window, it opens the target entity list and allows you to select one. Recommended for entities with large data.
* **Dropdown**: A dropdown will allow you to select a navigation property. Recommended for entities with fewer data.

In this example scenario, we will create a `Student` entity and add a navigation property to the already existing entity `Teacher`. In the end, the user will be able select a teacher for a student.
See the screenshot that shows you how to do this:

![Navigation property example](../images/suite-navigation-property-create-new.png)

### Saving an entity

There are 2 options to save an entity.

#### Save

Saves only the entity as draft and doesn't generate code. This is useful when you don't want to apply changes to your project.

#### Save and generate

Saves the entity and generates code. Your project will be added a new CRUD page.

### Database table

When you click **Save and generate** button it'll create all the related objects. The below screenshot is the MS SQL database table that's generated via ABP Suite.

![Database table for the new entity](../images/suite-database-table.png)

## User interface

### New book dialog
Expand Down
4 changes: 4 additions & 0 deletions en/docs-nav.json
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,10 @@
{
"text": "Twilio SMS",
"path": "modules/twilio-sms.md"
},
{
"text": "Payment",
"path": "modules/payment.md"
}
]
},
Expand Down
19 changes: 17 additions & 2 deletions en/guides/customizing-modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ ABP Commercial adds **more extension points** on top of the ABP Framework.

> This section **only focuses on the additional features** provided by the ABP Commercial. You should definitely see the guide mentioned in the previous section.
### Entity Actions
### User Interface

#### Entity Actions

Entity action extension system allows you to add a new action to the action menu for an entity. A "Click Me" action was added to the user management page below:

Expand All @@ -23,4 +25,17 @@ You can take **any action** (open a modal, make an HTTP API call, redirect to an
See the related documents to learn how to use this system:

* [Entity Action Extensions for ASP.NET Core UI](../ui/aspnetcore/entity-action-extensions.md)
* [Entity Action Extensions for Angular](../ui/angular/entity-action-extensions.md)
* [Entity Action Extensions for Angular](../ui/angular/entity-action-extensions.md)

#### Page Toolbar

Page toolbar system allows you to add components to the toolbar of any page. The page toolbar is the area right to the header of a page. A button ("Import users from excel") was added to the user management page below:

![page-toolbar-button](../images/page-toolbar-button.png)

You can add any type of view component item to the page toolbar or modify existing items.

See the related documents to learn how to use this system:

* [Page Toolbar Extensions for ASP.NET Core UI](../ui/aspnetcore/page-toolbar-extensions.md)
* [Page Toolbar Extensions for Angular](../ui/angular/page-toolbar-extensions.md)
Binary file added en/images/page-toolbar-button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added en/images/page-toolbar-custom-component.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified en/images/suite-entity-with-navigation-property.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed en/images/suite-example-navigation-entity-dto.png
Binary file not shown.
Binary file removed en/images/suite-example-navigation-entity.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file removed en/images/suite-navigation-property.png
Binary file not shown.
Binary file removed en/images/suite-np-define.png
Binary file not shown.
26 changes: 26 additions & 0 deletions en/modules/payment.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,32 @@ Configure<PaymentOptions>(options =>
* ```Recommended```: Is payment gateway is recommended or not. This information is displayed on payment gateway selection page.
* ```ExtraInfos```: List of informative strings for payment gateway. These texts are displayed on payment gateway selection page.

### PayuOptions

```PayuOptions``` is used to configure PayU payment gateway options.

* ```Merchant```: Merchant code for PayU account.
* ```Signature```: Signature of Merchant.
* ```LanguageCode```: Language of the order. This will be used for notification email that are sent to the client, if available.
* ```CurrencyCode```: Currency code of order (USD, EUR, etc...).
* ```VatRate```: Vat rate of order.
* ```PriceType```: Price type of order (GROSS or NET).
* ```Shipping```: A positive number indicating the price of shipping.
* ```Installment```: The number of installments. It can be an integer between 1 and 12.
* ```TestOrder```: Is the order a test order or not (true or false).
* ```Debug```: Writes detailed log on PAYU side.
* ```Recommended```: Is payment gateway is recommended or not. This information is displayed on payment gateway selection page.
* ```ExtraInfos```: List of informative strings for payment gateway. These texts are displayed on payment gateway selection page.

### TwoCheckoutOptions

* Signature: Signature of Merchant's 2Checkout account.
* CheckoutUrl: 2Checkout checkout URL (it must be set to https://secure.2checkout.com/order/checkout.php).
* ```LanguageCode```: Language of the order. This will be used for notification email that are sent to the client, if available.
* ```CurrencyCode```: Currency code of order (USD, EUR, etc...).
* ```Recommended```: Is payment gateway is recommended or not. This information is displayed on payment gateway selection page.
* ```ExtraInfos```: List of informative strings for payment gateway. These texts are displayed on payment gateway selection page.

Instead of configuring options in your module class, you can configure it in your appsettings.json file like below;

```json
Expand Down
5 changes: 5 additions & 0 deletions en/ui/angular/.prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"singleQuote": true,
"trailingComma": "all",
"arrowParens": "avoid"
}
Loading

0 comments on commit dbb7967

Please sign in to comment.