Spiderly Attributes

Usage:

Provides authentication protection for API endpoints by validating JWT tokens in the request.

Usage:

Marks a string property as a reference to a file stored in Azure Blob Storage. This property will contain the unique identifier (blob name) used to locate and access the file in Azure Storage.

When you add a property decorated with the BlobNameAttribute inside your entity, Spiderly will automatically generate an additional property in the corresponding DTO (e.g., ProfilePictureData). This new property will contain the Base64-encoded string of the file. To display this image in your HTML, use the Spiderly helper method getHtmlImgDisplayString64 and pass its result as the src attribute of an <img> tag.

Example:

Usage:

Implements cascade delete behavior in many-to-one relationships. When the referenced entity is deleted, all entities that reference it will automatically be deleted as well.

This attribute is useful when:

- Child entities should not exist without their parent

Example:

Usage:

Specifies a custom controller name for an entity, overriding the default naming convention. This attribute allows grouping multiple related entities under a single controller.

Default behavior without 'Controller' attribute:

Controllers are named as '{EntityName}Controller'

Example:

Usage:

Marks a class for custom object mapping implementation.

Example:

Note:

Use this attribute when you need to implement specialized mapping logic that cannot be handled by the default mapping configuration.

Usage:

Specifies which property should be used as the display name for an entity in UI elements:
- When applied to a property: The property's value will be used to represent the entity
- When applied to a class: The specified property's value will be used to represent the entity
- If no property or class is marked with this attribute: The entity's 'Id' will be used

Example:

Usage:

Disables authorization checks for CRUD operations on the decorated entity. By default, all entities require authorization for CRUD operations.

Warning:

This attribute bypasses security checks and should be used with extreme caution. It is primarily intended for testing purposes and should generally be avoided in production environments.

Usage:

Specifies that a property should be excluded from the generated DTO.

Usage:

Prevents the generation of standard business service methods for the decorated property in the BusinessServiceGenerated class.

Use this attribute when you want to:

- Implement custom business logic instead of using generated methods
- Override the default generated behavior with your own implementation
- Exclude specific properties from the standard service method generation

Note:

The property will still be part of the entity, but no service methods will be generated for it in the BusinessServiceGenerated class.

Usage:

Generates a string property in the DTO containing comma-separated display names for a collection property in the entity.

Example:

Usage:

Specifies that a property should be included in the generated DTO. This attribute is particularly useful for enumerable properties, which are not included in DTOs by default.

Note:

This attribute only affects DTO generation and does not influence the mapping behavior (Entity <-> DTO).

Usage:

Indicates that the entity represents a helper table for a many-to-many (M2M) relationship.

Example:

Usage:

Marks a property in a many-to-many (M2M) relationship.

Example:

Usage:

Specifies the output configuration for the Source Generator.

Note:

This is a temporary solution and may be replaced in future versions.

Usage:

Specifies custom mapping configuration when projecting an entity to its DTO.

Example:

Usage:

Specifies that the property should be set to null when the parent entity is deleted.
Apply this attribute to a many-to-one relationship property.

Usage:

Specifies that a table items for the many-to-many relationship administration should be loaded lazily (on-demand) rather than eagerly.

Usage:

Indicates that the loading spinner should be skipped for the decorated controller method.

Use when:

- The operation is very quick and doesn't need a loading indicator
- You want to implement custom loading behavior
- The operation runs in the background

Example:

Usage:

Specifies additional permission requirements for inserting entities in the UI. The user must have ONE of the specified permissions to perform the insert operation. Multiple instances of this attribute can be applied to a single entity.

Usage:

Specifies additional permission requirements for updating entities in the UI. The user must have ONE of the specified permissions to perform the update operation. Multiple instances of this attribute can be applied to a single entity.

Usage:

Specifies the UI control type for a property.

If not specified, the control type is automatically determined based on the property type:
- string: TextBox (or TextArea if [StringLength] value is large)
- int/long: Number
- decimal: Decimal
- bool: CheckBox
- DateTime: Calendar
- many-to-one: Autocomplete

Example:

Usage:

Specifies the width of a UI field using PrimeNG (PrimeFlex) column classes.

Default values:

- "col-12" for TextArea and Editor controls
- "col-12 md:col-6" for all other controls

Example:

Usage:

Excludes a property from being generated in the UI main form component.

Example:

Usage:

Enables management of child entities through an ordered list in the parent entity's main UI form component.

Example:

Usage:

Specifies in which panel the UI control will be located. By default, all controls are inside the "Details" panel.

Example:

Usage:

Specifies the display order of UI controls. Controls are displayed in the order of property declaration, except for: 'file', 'text-area', 'editor', and 'table' controls, which are always displayed last in their declaration order.

Example:

Usage:

Specifies which columns should be displayed in a table view for a many-to-many relationship. Must be used in combination with [SimpleManyToManyTableLazyLoad] attribute.

Example:

Usage:

Specifies the collection navigation property name in a related entity for establishing a bidirectional relationship in Entity Framework.

Purpose:

This attribute is used to define the inverse navigation property in a relationship, enabling proper relationship configuration and navigation in both directions.

Example: