Skip to main content

​
Overview

OutputFieldAttribute is used to decorate properties that represent output fields in form responses. Output fields are used to display data to the user but do not accept input. This attribute extends FieldAttribute and is categorized as an output component.

​
Namespace

UiMetadataFramework.Core.Binding

​
Inheritance

FieldAttribute → OutputFieldAttribute

​
Properties

All properties are inherited from FieldAttribute:
​
Label
string
Display label for the field. If not specified, the property name will be used.
​
Hidden
bool
default:"false"
Indicates whether this field should be visible in the UI. Hidden fields are not displayed to the user.
​
OrderIndex
int
default:"0"
Controls the rendering position of this field relative to other output fields. Fields are displayed in ascending order of their OrderIndex values.
​
Category
string
Component category that this field attribute supports. For OutputFieldAttribute, this is always "output". This property is set by the constructor and cannot be changed.

​
Usage Examples

​
Basic Output Fields

public class UserProfileResponse
{
    [OutputField(Label = "User ID")]
    public int Id { get; set; }
    
    [OutputField(Label = "Full Name", OrderIndex = 1)]
    public string Name { get; set; }
    
    [OutputField(Label = "Email Address", OrderIndex = 2)]
    public string Email { get; set; }
    
    [OutputField(Label = "Member Since", OrderIndex = 3)]
    public DateTime RegistrationDate { get; set; }
}

​
Report with Ordered Fields

public class SalesReportResponse
{
    [OutputField(Label = "Report Period", OrderIndex = 1)]
    public string Period { get; set; }
    
    [OutputField(Label = "Total Sales", OrderIndex = 2)]
    public decimal TotalSales { get; set; }
    
    [OutputField(Label = "Number of Orders", OrderIndex = 3)]
    public int OrderCount { get; set; }
    
    [OutputField(Label = "Average Order Value", OrderIndex = 4)]
    public decimal AverageOrderValue { get; set; }
    
    [OutputField(Label = "Top Product", OrderIndex = 5)]
    public string TopProduct { get; set; }
}

​
Hidden Output Fields

public class DocumentResponse
{
    [OutputField(Hidden = true)]
    public Guid InternalId { get; set; }
    
    [OutputField(Label = "Document Title")]
    public string Title { get; set; }
    
    [OutputField(Label = "Content")]
    public TextOutputValue Content { get; set; }
    
    [OutputField(Label = "Last Modified")]
    public DateTime LastModified { get; set; }
}

​
Complex Output Types

public class DashboardResponse
{
    [OutputField(Label = "Statistics", OrderIndex = 1)]
    public TableValue<StatisticsRow> Statistics { get; set; }
    
    [OutputField(Label = "Recent Activity", OrderIndex = 2)]
    public InlineForm<ActivityList> RecentActivity { get; set; }
    
    [OutputField(Label = "Alerts", OrderIndex = 3)]
    public Alert[] Alerts { get; set; }
}

public class StatisticsRow
{
    [OutputField(Label = "Metric")]
    public string MetricName { get; set; }
    
    [OutputField(Label = "Value")]
    public string Value { get; set; }
    
    [OutputField(Label = "Change")]
    public string Change { get; set; }
}

​
Form with Input and Output Fields

[Form(Id = "calculate-loan", Label = "Loan Calculator")]
public class LoanCalculatorForm
{
    // Input section
    [InputField(Label = "Loan Amount", Required = true, OrderIndex = 1)]
    public decimal LoanAmount { get; set; }
    
    [InputField(Label = "Interest Rate (%)", Required = true, OrderIndex = 2)]
    public decimal InterestRate { get; set; }
    
    [InputField(Label = "Loan Term (years)", Required = true, OrderIndex = 3)]
    public int LoanTermYears { get; set; }
}

public class LoanCalculatorResponse
{
    // Output section
    [OutputField(Label = "Monthly Payment", OrderIndex = 1)]
    public decimal MonthlyPayment { get; set; }
    
    [OutputField(Label = "Total Interest", OrderIndex = 2)]
    public decimal TotalInterest { get; set; }
    
    [OutputField(Label = "Total Amount", OrderIndex = 3)]
    public decimal TotalAmount { get; set; }
    
    [OutputField(Label = "Amortization Schedule", OrderIndex = 4)]
    public TableValue<PaymentRow> AmortizationSchedule { get; set; }
}

​
Read-Only Data Display

public class OrderDetailsResponse
{
    [OutputField(Label = "Order Number", OrderIndex = 1)]
    public string OrderNumber { get; set; }
    
    [OutputField(Label = "Status", OrderIndex = 2)]
    public string Status { get; set; }
    
    [OutputField(Label = "Order Date", OrderIndex = 3)]
    public DateTime OrderDate { get; set; }
    
    [OutputField(Label = "Items", OrderIndex = 4)]
    public TableValue<OrderItem> Items { get; set; }
    
    [OutputField(Label = "Subtotal", OrderIndex = 5)]
    public decimal Subtotal { get; set; }
    
    [OutputField(Label = "Tax", OrderIndex = 6)]
    public decimal Tax { get; set; }
    
    [OutputField(Label = "Total", OrderIndex = 7)]
    public decimal Total { get; set; }
}

​
Notes

  • Output fields are read-only and used for displaying data to users.
  • The OrderIndex property allows you to control the display order of fields.
  • Hidden output fields can be useful for storing metadata that shouldn’t be displayed but needs to be included in the response.
  • Output fields support complex types like tables, inline forms, and custom output components.

​
See Also

Build docs developers (and LLMs) love

Get started for freeTalk to us