1. IronPDF
  2. IronPDF博客
  3. .NET 帮助
  4. csharp-attributes-指南
.NET 帮助

C# 特性（开发人员如何使用）

发布 2024年二月18日
分享:

在 C# 编程世界中，元数据在丰富代码语义和行为方面发挥着至关重要的作用。 *C# 属性***作为一种强大的工具出现，它使开发人员能够为代码中的各种实体附加元数据，从而影响编译器、工具和运行时环境解释这些实体并与之交互的方式。

在本综合指南中，我们将了解 C# 属性，探讨它们的语法、应用，以及它们如何作为增强代码表现力和功能的通用机制。

了解 C# 属性：入门

属性，用方括号表示([])在代码元素上方放置的声明性标记是"，......"，用于提供有关这些元素的附加信息。 这些附加信息也称为元数据，不会影响代码的核心功能，但能为编译器、运行时环境和工具提供有价值的见解。

在 C# 中，对象属性表示与类或方法等程序实体相关联的元数据。 使用属性语法定义的属性实例可增强对程序实体的描述，例如使用 `Conditional("DEBUG)有条件地包含代码。

下面是一个在 C# 中使用属性的基本示例：

[Serializable]
public class Person
{
    // Class Implementation
}
[Serializable]
public class Person
{
    // Class Implementation
}
<Serializable>
Public Class Person
	' Class Implementation
End Class
VB   C#

在本例中，"Serializable "属性表示 "Person "类的实例可以被序列化。

C# 属性类型

属性适用于 C# 代码中的各种元素，包括

  1. 汇编： 适用于整个汇编，在编译和执行过程中影响其行为。
    [assembly: AssemblyVersion("1.0.0.0")]
    [assembly: AssemblyVersion("1.0.0.0")]
<Assembly: AssemblyVersion("1.0.0.0")>
VB   C#
  1. 模块： 应用于程序集内的模块，提供有关模块本身的信息。
    [module: SomeCustomModuleAttribute]
    [module: SomeCustomModuleAttribute]
IRON VB CONVERTER ERROR developers@ironsoftware.com
VB   C#
  1. 类型： 应用于类型，影响其行为或提供额外信息。
    [Serializable]
        public class Person
        {
            // Class Implementation
        }
    [Serializable]
        public class Person
        {
            // Class Implementation
        }
IRON VB CONVERTER ERROR developers@ironsoftware.com
VB   C#
  1. 方法： 应用于方法，改变其行为或为工具提供信息。
    [Obsolete("Use the newMethod instead.")]
        public void DeprecatedMethod()
        {
            // Method implementation
        }
    [Obsolete("Use the newMethod instead.")]
        public void DeprecatedMethod()
        {
            // Method implementation
        }
IRON VB CONVERTER ERROR developers@ironsoftware.com
VB   C#
  1. 属性、字段、事件等： 应用于类型中的特定成员，提供与这些成员相关的元数据。
    public class Example
        {
            [DefaultValue(42)]
            public int Answer { get; set; }
        }
    public class Example
        {
            [DefaultValue(42)]
            public int Answer { get; set; }
        }
Public Class Example
			<DefaultValue(42)>
			Public Property Answer() As Integer
End Class
VB   C#

在C#中创建自定义属性

虽然 C# 提供了大量内置属性，但开发人员也可以创建自定义属性来传达代码的特定信息。 自定义属性是通过创建一个继承自 System.Attribute 的类来定义的：

[AttributeUsage(AttributeTargets.Class 
 AttributeTargets.Method, AllowMultiple = true)]
public class CustomAttribute : Attribute
{
    // Attribute Implementation
}
[AttributeUsage(AttributeTargets.Class 
 AttributeTargets.Method, AllowMultiple = true)]
public class CustomAttribute : Attribute
{
    // Attribute Implementation
}
IRON VB CONVERTER ERROR developers@ironsoftware.com
VB   C#

在本例中，"CustomAttribute"（自定义属性）可应用于类和方法，而 "AllowMultiple"（允许多个）属性则指定是否允许在单个目标上使用多个属性实例。 在创建自定义属性类时，会在类名后添加属性后缀，以区别于普通类。 属性构造器初始化了这些属性，位置参数则在向这些属性传递值时发挥作用，从而在代码中提供结构化信息。

C# 属性的应用

1.代码文档

属性在记录代码和为开发人员或工具提供附加信息方面起着至关重要的作用。 例如，[过时] 属性表示不应再使用特定元素，开发人员应迁移到其他元素。

[Obsolete("This method is obsolete. Use the newMethod instead.")]
public void DeprecatedMethod()
{
    // Method Implementation
}
[Obsolete("This method is obsolete. Use the newMethod instead.")]
public void DeprecatedMethod()
{
    // Method Implementation
}
<Obsolete("This method is obsolete. Use the newMethod instead.")>
Public Sub DeprecatedMethod()
	' Method Implementation
End Sub
VB   C#

2.序列化和持久性

属性如 [可序列化] 告知运行时环境类型的实例可以序列化。 在处理数据持久性等场景时，这一点至关重要。

[Serializable]
public class Person
{
    // Class implementation
}
[Serializable]
public class Person
{
    // Class implementation
}
<Serializable>
Public Class Person
	' Class implementation
End Class
VB   C#

3.代码分析和工具集成

属性有助于静态分析和代码生成工具。 例如，单元测试框架等工具使用 "TestMethod "等属性来标识测试方法。

[TestClass]
public class MyTestClass
{
    [TestMethod]
    public void TestMethod()
    {
        // Test method implementation
    }
}
[TestClass]
public class MyTestClass
{
    [TestMethod]
    public void TestMethod()
    {
        // Test method implementation
    }
}
<TestClass>
Public Class MyTestClass
	<TestMethod>
	Public Sub TestMethod()
		' Test method implementation
	End Sub
End Class
VB   C#

4.ASP.NET MVC 路由

在 ASP.NET MVC 中，属性被广泛用于路由。 路由 "属性允许开发人员为操作方法指定路由模板。

[Route("api/[controller]")]
public class SampleController : Controller
{
    [HttpGet]
    [Route("GetSampleData")]
    public IActionResult GetSampleData()
    {
        // Action method implementation
    }
}
[Route("api/[controller]")]
public class SampleController : Controller
{
    [HttpGet]
    [Route("GetSampleData")]
    public IActionResult GetSampleData()
    {
        // Action method implementation
    }
}
<Route("api/[controller]")>
Public Class SampleController
	Inherits Controller

	<HttpGet>
	<Route("GetSampleData")>
	Public Function GetSampleData() As IActionResult
		' Action method implementation
	End Function
End Class
VB   C#

介绍 IronPDF：简要概述

IronPDF 概述作为一个为 C# .NET Framework 开发人员量身定做的多功能库，《PDF 文件系统》为 PDF 生成和操作提供了一套广泛的工具。 从从 HTML 创建 PDF 到从现有文档中提取内容，IronPDF 简化了复杂的任务，使其成为开发人员工具包中的宝贵资产。

C# 属性（如何为开发人员工作）：图 1 - IronPDF 网页

安装 IronPDF：快速入门

要开始在您的 C# 项目中利用 IronPDF 库，您可以轻松安装 IronPDF NuGet 软件包。 在软件包管理器控制台中使用以下命令：

Install-Package IronPdf

或者，您也可以在 NuGet 软件包管理器中搜索 "IronPDF"，然后安装。

C# 属性：快速概述

C# 属性是声明性标签，可提供代码中实体的附加信息，如类、方法或属性。 如上所述，这些工具使开发人员能够在不改变代码核心功能的情况下附加元数据或定义行为。 随着我们继续探索属性与 IronPDF 的整合，我们将发现它们如何有助于以更细致入微的方式生成 PDF。

使用 C# 属性增强 PDF 生成功能

1.自定义文档元数据

可以使用属性来丰富与 PDF 文档相关的元数据。 IronPdf 允许开发人员自定义标题、作者和主题等元数据元素。 通过使用属性，您可以在生成的 PDF 中动态注入这些信息。 下面的示例演示了如何使用 IronPDF 的不同属性类：

PdfGenerationWithAttributes obj = new PdfGenerationWithAttributes();
obj.GeneratePdf();
// Define the DocumentMetadataAttribute
public class DocumentMetadataAttribute : Attribute
{
    public string Title { get; set; }
    public string Author { get; set; }
    public string Subject { get; set; }
}
[DocumentMetadata(Title = "Custom PDF Title", Author = "John Doe", Subject = "Document Subject")]
public class PdfGenerationWithAttributes
{
    public void GeneratePdf()
    {
        // Instantiate IronPDF PdfDocument
        var pdfDocument = new PdfDocument("StyledDocument.pdf");
        // Retrieve DocumentMetadataAttribute using reflection
        var documentMetadata = typeof(PdfGenerationWithAttributes)
            .GetCustomAttributes(typeof(DocumentMetadataAttribute), false)
            .FirstOrDefault() as DocumentMetadataAttribute;
        // Set metadata values
        pdfDocument.MetaData.Title = documentMetadata?.Title;
        pdfDocument.MetaData.Author = documentMetadata?.Author;
        pdfDocument.MetaData.Subject = documentMetadata?.Subject;
        // Perform document generation
        pdfDocument.SaveAs("CustomizedDocument.pdf");
    }
}
PdfGenerationWithAttributes obj = new PdfGenerationWithAttributes();
obj.GeneratePdf();
// Define the DocumentMetadataAttribute
public class DocumentMetadataAttribute : Attribute
{
    public string Title { get; set; }
    public string Author { get; set; }
    public string Subject { get; set; }
}
[DocumentMetadata(Title = "Custom PDF Title", Author = "John Doe", Subject = "Document Subject")]
public class PdfGenerationWithAttributes
{
    public void GeneratePdf()
    {
        // Instantiate IronPDF PdfDocument
        var pdfDocument = new PdfDocument("StyledDocument.pdf");
        // Retrieve DocumentMetadataAttribute using reflection
        var documentMetadata = typeof(PdfGenerationWithAttributes)
            .GetCustomAttributes(typeof(DocumentMetadataAttribute), false)
            .FirstOrDefault() as DocumentMetadataAttribute;
        // Set metadata values
        pdfDocument.MetaData.Title = documentMetadata?.Title;
        pdfDocument.MetaData.Author = documentMetadata?.Author;
        pdfDocument.MetaData.Subject = documentMetadata?.Subject;
        // Perform document generation
        pdfDocument.SaveAs("CustomizedDocument.pdf");
    }
}
Private obj As New PdfGenerationWithAttributes()
obj.GeneratePdf()
' Define the DocumentMetadataAttribute
'INSTANT VB TODO TASK: Local functions are not converted by Instant VB:
'public class DocumentMetadataAttribute : Attribute
'{
'	public string Title
'	{
'		get;
'		set;
'	}
'	public string Author
'	{
'		get;
'		set;
'	}
'	public string Subject
'	{
'		get;
'		set;
'	}
'}
'INSTANT VB TODO TASK: Local functions are not converted by Instant VB:
'[DocumentMetadata(Title = "Custom PDF Title", Author = "John Doe", Subject = "Document Subject")]
'public class PdfGenerationWithAttributes
'{
'	public void GeneratePdf()
'	{
'		' Instantiate IronPDF PdfDocument
'		var pdfDocument = New PdfDocument("StyledDocument.pdf");
'		' Retrieve DocumentMetadataAttribute using reflection
'		var documentMetadata = TryCast(typeof(PdfGenerationWithAttributes).GetCustomAttributes(typeof(DocumentMetadataAttribute), False).FirstOrDefault(), DocumentMetadataAttribute);
'		' Set metadata values
'		pdfDocument.MetaData.Title = If(documentMetadata Is Nothing, Nothing, documentMetadata.Title);
'		pdfDocument.MetaData.Author = If(documentMetadata Is Nothing, Nothing, documentMetadata.Author);
'		pdfDocument.MetaData.Subject = If(documentMetadata Is Nothing, Nothing, documentMetadata.Subject);
'		' Perform document generation
'		pdfDocument.SaveAs("CustomizedDocument.pdf");
'	}
'}
VB   C#

在此示例中，"DocumentMetadataAttribute "作为一个自定义属性，用于传递元数据信息，允许在 PDF 生成过程中进行动态自定义。 所提供的代码用 C# 定义了一个名为 DocumentMetadataAttribute 的自定义属性类。 属性是为类、方法或属性等程序实体添加元数据或声明性信息的一种方式。 然后，这些属性将通过反射用于编辑 PDF 文档的 "MetaData"。

C# 属性（如何为开发人员工作）：图 2 - 通过 文档属性 查看输出 PDF 的元数据

2.用属性控制 PDF 布局

还可以利用属性来控制 PDF 文档的布局。 IronPdf 提供设置页面大小、页边距和方向的选项。 通过使用属性，您可以根据具体要求对这些布局设置进行参数化：

[PageLayout(Size = IronPdf.Rendering.PdfPaperSize.A4, MarginTop = 20, MarginBottom = 20, MarginLeft = 10, MarginRight = 10)]
public class PdfGenerationWithLayoutAttributes
{
    public void GeneratePdf()
    {
        // Instantiate IronPDF PdfDocument
        var pdfDocument = new ChromePdfRenderer();
        // Retrieve PageLayoutAttribute using reflection
        var pageLayout = typeof(PdfGenerationWithLayoutAttributes)
            .GetCustomAttributes(typeof(PageLayoutAttribute), false)
            .FirstOrDefault() as PageLayoutAttribute;
        // Set layout values
        pdfDocument.RenderingOptions.PaperSize = pageLayout?.Size;
        pdfDocument.RenderingOptions.MarginTop = pageLayout?.MarginTop ?? 0;
        pdfDocument.RenderingOptions.MarginBottom = pageLayout?.MarginBottom ?? 0;
        pdfDocument.RenderingOptions.MarginLeft = pageLayout?.MarginLeft ?? 0;
        pdfDocument.RenderingOptions.MarginRight = pageLayout?.MarginRight ?? 0;
        // Perform document generation
        pdfDocument.RenderHtmlAsPdf("<html><body><h1>Hello, IronPDF!</h1></body></html>").SaveAs("CustomLayoutDocument.pdf");
    }
}
[PageLayout(Size = IronPdf.Rendering.PdfPaperSize.A4, MarginTop = 20, MarginBottom = 20, MarginLeft = 10, MarginRight = 10)]
public class PdfGenerationWithLayoutAttributes
{
    public void GeneratePdf()
    {
        // Instantiate IronPDF PdfDocument
        var pdfDocument = new ChromePdfRenderer();
        // Retrieve PageLayoutAttribute using reflection
        var pageLayout = typeof(PdfGenerationWithLayoutAttributes)
            .GetCustomAttributes(typeof(PageLayoutAttribute), false)
            .FirstOrDefault() as PageLayoutAttribute;
        // Set layout values
        pdfDocument.RenderingOptions.PaperSize = pageLayout?.Size;
        pdfDocument.RenderingOptions.MarginTop = pageLayout?.MarginTop ?? 0;
        pdfDocument.RenderingOptions.MarginBottom = pageLayout?.MarginBottom ?? 0;
        pdfDocument.RenderingOptions.MarginLeft = pageLayout?.MarginLeft ?? 0;
        pdfDocument.RenderingOptions.MarginRight = pageLayout?.MarginRight ?? 0;
        // Perform document generation
        pdfDocument.RenderHtmlAsPdf("<html><body><h1>Hello, IronPDF!</h1></body></html>").SaveAs("CustomLayoutDocument.pdf");
    }
}
<PageLayout(Size := IronPdf.Rendering.PdfPaperSize.A4, MarginTop := 20, MarginBottom := 20, MarginLeft := 10, MarginRight := 10)>
Public Class PdfGenerationWithLayoutAttributes
	Public Sub GeneratePdf()
		' Instantiate IronPDF PdfDocument
		Dim pdfDocument = New ChromePdfRenderer()
		' Retrieve PageLayoutAttribute using reflection
		Dim pageLayout = TryCast(GetType(PdfGenerationWithLayoutAttributes).GetCustomAttributes(GetType(PageLayoutAttribute), False).FirstOrDefault(), PageLayoutAttribute)
		' Set layout values
		pdfDocument.RenderingOptions.PaperSize = pageLayout?.Size
		pdfDocument.RenderingOptions.MarginTop = If(pageLayout?.MarginTop, 0)
		pdfDocument.RenderingOptions.MarginBottom = If(pageLayout?.MarginBottom, 0)
		pdfDocument.RenderingOptions.MarginLeft = If(pageLayout?.MarginLeft, 0)
		pdfDocument.RenderingOptions.MarginRight = If(pageLayout?.MarginRight, 0)
		' Perform document generation
		pdfDocument.RenderHtmlAsPdf("<html><body><h1>Hello, IronPDF!</h1></body></html>").SaveAs("CustomLayoutDocument.pdf")
	End Sub
End Class
VB   C#

在本例中，"PageLayoutAttribute "用于封装页面布局设置，允许根据属性值进行动态调整。

结论

总之，C# 属性是在代码中嵌入元数据的一种宝贵机制，可以影响工具、编译器和运行环境对代码的解释和处理。 无论是使用内置属性还是自定义属性，开发人员都可以利用属性来增强代码的表现力，实现工具集成，并塑造应用程序的行为。

C# 属性与 IronPDF 的整合为更细致、更动态的 PDF 生成开辟了途径。 无论是定制元数据还是微调布局设置，属性都提供了一种声明式方法来增强 IronPDF 的功能。 在探索可能性的过程中，请考虑您的 PDF 生成任务的具体需求，以及属性如何有助于 IronPDF 实现更定制、更高效的流程。

IronPdf 的开发是免费的，但有一些限制，您可以通过以下方式解除这些限制IronPDF 完整功能测试许可证.

< 前一页
C# String.Format（开发人员如何使用）
下一步 >
C# 委托（开发者如何使用）

报告问题

准备开始了吗？ 版本： 2024.12 刚刚发布

免费NuGet下载 总下载量: 11,781,565 查看许可证 >