API Reference ar

English · 简体中文 · 繁體中文 · Español · العربية · Français · Português (Brasil) · Deutsch · हिन्दी · 日本語 · 한국어 · Русский · Bahasa Indonesia · Türkçe · Italiano · Tiếng Việt

مرجع API لمكتبة docxi: الأصناف والدوال

مكتبة docxi مكتبة Ruby، لذا تسرد هذه الصفحة واجهتها البرمجية في Ruby، ولا توجد واجهة HTTP. خيارات كل دالة موصوفة في صفحة الميزات، والأصناف مشروحة في صفحة البنية.

الصنف Docxi::Document

الدالة	القيمة المُعادة	ملاحظات
Docxi::Document.new(options = {})	كائن Document	الخيارات options هي هوامش الصفحة. راجع الإعدادات
#document	Docxi::Word::Document	المتن الذي تضيف إليه المحتوى
#render	StringIO	حزمة .docx الكاملة. تعيد .string البايتات

الصنف Docxi::Word::Document ‏(word.document)

الدالة	القيمة المُعادة	ما تضيفه
p(options = {}) { |p| }	كائن Paragraph	فقرة
text(string, options = {})	كائن Paragraph	فقرة بمقطع نصي واحد
br(page: true)	كائن Break	فاصل صفحات
tab(page: true)	كائن Tab	فقرة تحتوي على علامة جدولة واحدة
table(options = {}) { |table| }	كائن Table	جدول
table_of_content(options = {}) { |toc| }	كائن TableOfContent	أسطر جدول المحتويات
frame(text, options = {})	كائن Paragraph	فقرة تحتوي على مربع نص
add_media(io_path_or_url, options = {})	كائن Media	صورة تضعها باستخدام image
add_hyperlink(url, options = {})	سلسلة نصية (String)	معرّف علاقة لاستخدامه مع hyperlink
add_header(header) وadd_first_header(header)	كائن Header	رأس الصفحات من 2 فصاعدًا، ورأس الصفحة 1
add_footer(footer) وadd_first_footer(footer)	كائن Footer	تذييل الصفحات من 2 فصاعدًا، وتذييل الصفحة 1

الفقرة (Docxi::Word::Contents::Paragraph)

الدالة	ما تضيفه
text(string, options = {})	مقطع نصي. خيارات الفقرة هي قيمه الافتراضية
br(times: 1)	فواصل أسطر
tab(times: 1)	علامات جدولة
image(media, options = {})	صورة مضمّنة أو محددة الموضع
hyperlink(text, url, id)	ارتباط يستخدم معرّف العلاقة id الذي أعادته add_hyperlink
frame(options = {}) { |frame| }	مربع نص

الجداول

الدالة	ما تضيفه
Table#tr(options = {}) { |tr| }	صف. خيارات الجدول هي قيمه الافتراضية
TableRow#tc(options = {}) { |tc| }	خلية. خيارات الصف هي قيمها الافتراضية
TableCell#text(string, options = {})	فقرة. خيارات الخلية هي قيمها الافتراضية
TableCell#p(options = {}) { |p| }	فقرة بخياراتها الخاصة
TableCell#image(media, width:, height:)	صورة
TableCell#page_numbers	حقل رقم الصفحة

جدول المحتويات

الدالة	ما تضيفه
TableOfContent#add_row(text, page = nil, leader: "dot", pos: 9360)	سطر واحد في جدول المحتويات

رؤوس الصفحات وتذييلاتها

الصنف	الدوال
Docxi::Word::Headers::Header.new(options = {}) { |h| }	الدوال text وbr وtable وimage وpage_numbers(options = {})
Docxi::Word::Footers::Footer.new(options = {}) { |f| }	الدوال text وbr وtable وpage_numbers(options = {})

الإطارات

يقبل Docxi::Word::Contents::Frame داخل كتلته الدوال text وbr وtab وimage وframe.

الثوابت والدوال المساعدة

الاسم	المعنى
Docxi::VERSION	الإصدار المثبّت، مثل "0.1.0"
Docxi.write_entry(zip, name, data)	يكتب جزءًا واحدًا في الأرشيف بعد ضبط حجمه مسبقًا. تستخدمه كل الأجزاء داخليًا
Docxi::Util.blank? وDocxi::Util.present?	دوال مساعدة داخلية تتبع قواعد blank? في ActiveSupport

صفحات ذات صلة

• الميزات
• أمثلة الاستخدام
• البنية

---

→ الصفحة الرئيسية للويكي · README