HelpKit 8.6.4

HelpKit

Генератор справочных окон и текстов на основе атрибутов модели данных для WinForms-приложений.

Установка

dotnet add package HelpKit

API-справочник (класс HelpGenerator)

Show<T>(string title = "Справка")

Отображает модальное окно справки с таблицей описания полей модели T. Окно содержит DataGridView с колонками: Поле, Тип данных, Описание.

HelpGenerator.Show<Employee>("Справка по сотрудникам");

GenerateHtml<T>()

Генерирует полную HTML-страницу со справочной таблицей по модели T. Возвращает строку с HTML-разметкой, включая стили оформления. Таблица содержит колонки: Поле, Тип данных, Описание.

string html = HelpGenerator.GenerateHtml<Employee>();
File.WriteAllText("help.html", html);

GenerateText<T>()

Генерирует текстовое представление справки по модели T. Каждое поле выводится в формате: Название (тип): описание.

string text = HelpGenerator.GenerateText<Employee>();
Console.WriteLine(text);

ToDataTable<T>(string tableName = "Справка")

Возвращает DataTable со справочной информацией по модели T. Содержит колонки: Поле, Тип данных, Описание.

DataTable dt = HelpGenerator.ToDataTable<Employee>("Сотрудники");
dataGridView.DataSource = dt;

Особенности

• Поддержка атрибута [Display(Name = "...", Description = "...")] для пользовательских названий и описаний полей.
• Поддержка атрибута [Description("...")] для описаний.
• Автоматический перевод распространенных имен свойств (FullName, Salary, Phone и др.) на русский язык.
• Автоматическое определение типов данных (string, int, decimal, DateTime и др.).

Примеры использования

Справочное окно в WinForms

using HelpKit;
using System.ComponentModel;
using System.ComponentModel.DataAnnotations;

public class Employee
{
    public int Id { get; set; }

    [Display(Name = "ФИО", Description = "Полное имя сотрудника")]
    public string FullName { get; set; }

    [Display(Name = "Зарплата", Description = "Ежемесячная зарплата в рублях")]
    public decimal Salary { get; set; }
}

// Показать справку в окне
HelpGenerator.Show<Employee>("Справка: Сотрудники");

// Сохранить в HTML
string html = HelpGenerator.GenerateHtml<Employee>();
File.WriteAllText("справка_сотрудники.html", html);

Экспорт справки в различных форматах

// Текстовый формат
string text = HelpGenerator.GenerateText<Employee>();
File.WriteAllText("help.txt", text);

// DataTable для привязки к DataGridView
DataTable dt = HelpGenerator.ToDataTable<Employee>();
dataGridView1.DataSource = dt;