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

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

发布 2024年二月18日
分享:

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

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

Understanding C# Attributes：入门

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

在 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&num 的类型；属性

属性适用于 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&num 中创建自定义属性；

虽然 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&num 的应用；属性

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 IronPDF 是为 C# .NET Framework 开发人员量身定制的多功能库，为 PDF 生成和处理提供了一套广泛的工具。从从 HTML 创建 PDF 到从现有文档中提取内容，IronPDF 简化了复杂的任务，使其成为开发人员工具包中的宝贵资产。

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

安装 IronPDF：快速入门

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

Install-Package IronPdf

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

C# Attributes：快速概览

C# 属性是一种声明性标记，可为代码中的实体（如类、方法或属性）提供附加信息。它们使开发人员能够附加元数据或定义行为，而无需改变上述代码的核心功能。当我们继续探索属性与 IronPDF 的集成时，我们将发现属性如何有助于更细致地生成 PDF。

利用 C&num；属性增强 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 文档的 "元数据"。

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 的开发是免费的，但有一些限制，您可以通过以下方式解除这些限制 许可证 来测试该库的全部功能。

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

报告问题

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

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

获取您的免费

30天试用密钥 立即。

15天试用密钥 立即。

bullet_checked无需信用卡或创建账户
试用表格已提交
成功地。

您的试用密钥应在电子邮件中。
如果不是，请联系
support@ironsoftware.com

子弹测试测试生产环境
无水印
子弹日历30天全功能使用
功能性产品
子弹支持24/5技术支持
试用期间的支持

谢谢！

您的许可证密钥已发送到所提供的电子邮件。联系我们

24小时升级优惠：

Save 50% 在一个
专业 升级

去 专业 支持10位开发者
和无限项目。

小时

:

分钟

:

秒

升级到Professional

升级

专业

$600 美元

$299 美元

  • 10位开发者
  • 10个位置
  • 10个项目
今天 只有

5个.NET产品，两件的价格

IronPDF IronOCR IronXL IronBarcode IronWebscraper

套件总价值：

$7,192 美元

升级价格

今天
只有

$499 美元

24小时后

$1,098 美元