orchardcore-content-fields

Orchard Core Content Fields - Prompt Templates

Add and Configure Content Fields

You are an Orchard Core expert. Generate migration code and recipes for common content fields and verify feature-specific options against the enabled module.

Guidelines

• Fields are added to content parts using AlterPartDefinitionAsync in a migration.
• Each field has a FieldSettings base with Hint (string) and Required (bool).
• Each field type has its own specific settings class (e.g., TextFieldSettings, NumericFieldSettings).
• Fields also have ContentPartFieldSettings controlling DisplayName, Description, Editor, DisplayMode, and Position.
• Use .WithEditor("EditorName") to select an editor variant.
• Use .WithDisplayMode("DisplayModeName") to select a display variant.
• In templates, render field shapes (for example {{ Model.Content["Article-Summary"] | shape_render }}) rather than writing stored HTML or Markdown with raw; stored source is unsanitized.
• Third-party modules providing fields (CrestApps, Lombiq, community modules, etc.) must be installed as NuGet packages in the web project (the startup project of the solution), not just in the module project.
• Always seal classes.

General Pattern for Adding a Field

await _contentDefinitionManager.AlterPartDefinitionAsync("{{PartName}}", part => part
    .WithField("{{FieldName}}", field => field
        .OfType("{{FieldType}}")
        .WithDisplayName("{{DisplayName}}")
        .WithDescription("{{Description}}")
        .WithPosition("{{Position}}")
        .WithSettings(new {{FieldType}}Settings
        {
            // Field-specific settings
        })
    )
);

TextField

Stores a single text value. Supports multiple editor modes.

TextField Settings