FieldIndex
İçindekiler
[
Saklamak
]FieldIndex class
INDEX alanını uygular.
Daha fazla bilgi edinmek için şu adresi ziyaret edin:Alanlarla Çalışma belgeleme makalesi.
public class FieldIndex : Field
yapıcılar
| İsim | Tanım |
|---|---|
| FieldIndex() | Default_Constructor |
Özellikleri
| İsim | Tanım |
|---|---|
| BookmarkName { get; set; } | Dizin oluşturmak için kullanılan belge bölümünü işaretleyen yer iminin adını alır veya ayarlar. |
| CrossReferenceSeparator { get; set; } | Çapraz referansları ve diğer girdileri ayırmak için kullanılan karakter dizisini alır veya ayarlar. |
| DisplayResult { get; } | Görüntülenen alan sonucunu temsil eden metni alır. |
| End { get; } | Alan sonunu temsil eden düğümü alır. |
| EntryType { get; set; } | Dizini oluşturmak için kullanılan bir dizin giriş türünü alır veya ayarlar. |
| Format { get; } | Bir tane alırFieldFormatalanın biçimlendirmesine yazılmış erişim sağlayan nesne. |
| HasPageNumberSeparator { get; } | Sayfa numarası ayırıcısının alanın kodu aracılığıyla geçersiz kılınıp kılınmadığını belirten bir değer alır. |
| HasSequenceName { get; } | Alanın sonucu oluşturulurken bir dizinin kullanılıp kullanılmayacağını belirten bir değer alır. |
| Heading { get; set; } | Herhangi bir harf için her giriş kümesinin başında görünen bir başlığı alır veya ayarlar. |
| IsDirty { get; set; } | Belgede yapılan diğer değişiklikler nedeniyle alanın geçerli sonucunun artık doğru (eski) olup olmadığını alır veya ayarlar. |
| IsLocked { get; set; } | Alanın kilitli olup olmadığını alır veya ayarlar (sonucunu yeniden hesaplamamalıdır). |
| LanguageId { get; set; } | Dizin oluşturmak için kullanılan dil kimliğini alır veya ayarlar. |
| LetterRange { get; set; } | Dizin sınırını belirleyen harf aralığını alır veya ayarlar. |
| LocaleId { get; set; } | Alanın LCID’sini alır veya ayarlar. |
| NumberOfColumns { get; set; } | Dizin oluşturulurken sayfa başına kullanılan sütun sayısını alır veya ayarlar. |
| PageNumberListSeparator { get; set; } | Bir sayfa numarası listesinde iki sayfa numarasını ayırmak için kullanılan karakter dizisini alır veya ayarlar. |
| PageNumberSeparator { get; set; } | Bir dizin girişini ve sayfa numarasını ayırmak için kullanılan karakter dizisini alır veya ayarlar. |
| PageRangeSeparator { get; set; } | Bir sayfa aralığının başlangıcını ve sonunu ayırmak için kullanılan karakter dizisini alır veya ayarlar. |
| Result { get; set; } | Alan ayırıcısı ile alan sonu arasındaki metni alır veya ayarlar. |
| RunSubentriesOnSameLine { get; set; } | Alt girdilerin ana girdiyle aynı satıra çalıştırılıp çalıştırılmayacağını alır veya ayarlar. |
| Separator { get; } | Alan ayırıcısını temsil eden düğümü alır.hükümsüz . |
| SequenceName { get; set; } | Sayfa numarasına dahil olan bir dizinin adını alır veya ayarlar. |
| SequenceSeparator { get; set; } | Sıra numaralarını ve sayfa numaralarını ayırmak için kullanılan karakter dizisini alır veya ayarlar. |
| Start { get; } | Alanın başlangıcını temsil eden düğümü alır. |
| virtual Type { get; } | Microsoft Word alan türünü alır. |
| UseYomi { get; set; } | Dizin girişleri için yomi metninin kullanımının etkinleştirilip etkinleştirilmeyeceğini alır veya ayarlar. |
yöntemler
| İsim | Tanım |
|---|---|
| GetFieldCode() | Alan başlangıcı ile alan ayırıcısı (veya ayırıcı yoksa alan sonu) arasındaki metni döndürür. Hem alan kodu hem de alt alanların alan sonucu dahil edilir. |
| GetFieldCode(bool) | Alan başlangıcı ile alan ayırıcısı (veya ayırıcı yoksa alan sonu) arasındaki metni döndürür. |
| Remove() | Alanı belgeden kaldırır. Alanın hemen ardından bir düğüm döndürür. Alanın sonu, üst düğümünün son alt ‘siyse, üst paragrafını döndürür. Alan zaten kaldırılmışsa, şunu döndürürhükümsüz . |
| Unlink() | Alan bağlantısını kaldırma işlemini gerçekleştirir. |
| Update() | Alan güncellemesini gerçekleştirir. Alan zaten güncelleniyorsa fırlatır. |
| Update(bool) | Bir alan güncellemesi gerçekleştirir. Alan zaten güncelleniyorsa fırlatır. |
Notlar
XE alanları tarafından belirtilen dizin girişlerini kullanarak bir dizin oluşturur ve bu dizini belgenin bu noktasına ekler.
Örnekler
INDEX alanının nasıl oluşturulacağını ve ardından XE alanlarının bu alanı girişlerle nasıl dolduracağını gösterir.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Belgede bulunan her XE alanı için bir girdi görüntüleyecek bir INDEX alanı oluşturun.
// Her giriş, sol tarafta XE alanının Metin özelliği değerini gösterecektir
// ve sağ tarafta XE alanını içeren sayfa.
// XE alanlarının "Metin" özelliğinde aynı değer varsa,
// INDEX alanı bunları tek bir girdide gruplayacaktır.
FieldIndex index = (FieldIndex)builder.InsertField(FieldType.FieldIndex, true);
// INDEX alanını yalnızca sınırlar içindeki XE alanlarını görüntüleyecek şekilde yapılandırın
// "MainBookmark" adlı ve "EntryType" özelliklerinin değeri "A" olan bir yer iminin.
// Hem INDEX hem de XE alanları için, "EntryType" özelliği dize değerinin yalnızca ilk karakterini kullanır.
index.BookmarkName = "MainBookmark";
index.EntryType = "A";
Assert.AreEqual(" INDEX \\b MainBookmark \\f A", index.GetFieldCode());
// Yeni bir sayfada, yer imini değerle eşleşen bir adla başlatın
// INDEX alanının "BookmarkName" özelliği.
builder.InsertBreak(BreakType.PageBreak);
builder.StartBookmark("MainBookmark");
// INDEX alanı bu girişi alacaktır çünkü yer iminin içindedir,
// ve giriş tipi de INDEX alanının giriş tipiyle eşleşiyor.
FieldXE indexEntry = (FieldXE)builder.InsertField(FieldType.FieldIndexEntry, true);
indexEntry.Text = "Index entry 1";
indexEntry.EntryType = "A";
Assert.AreEqual(" XE \"Index entry 1\" \\f A", indexEntry.GetFieldCode());
// Giriş türleri eşleşmediği için DİZİN'de görünmeyecek bir XE alanı ekleyin.
builder.InsertBreak(BreakType.PageBreak);
indexEntry = (FieldXE)builder.InsertField(FieldType.FieldIndexEntry, true);
indexEntry.Text = "Index entry 2";
indexEntry.EntryType = "B";
// Yer imini sonlandır ve ardından bir XE alanı ekle.
// INDEX alanıyla aynı türdedir, ancak görünmeyecektir
// yer imi sınırlarının dışında olduğundan.
builder.EndBookmark("MainBookmark");
builder.InsertBreak(BreakType.PageBreak);
indexEntry = (FieldXE)builder.InsertField(FieldType.FieldIndexEntry, true);
indexEntry.Text = "Index entry 3";
indexEntry.EntryType = "A";
doc.UpdatePageLayout();
doc.UpdateFields();
doc.Save(ArtifactsDir + "Field.INDEX.XE.Filtering.docx");
XE alanlarını kullanarak bir INDEX alanının nasıl girdilerle doldurulacağını ve görünümünün nasıl değiştirileceğini gösterir.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Belgede bulunan her XE alanı için bir girdi görüntüleyecek bir INDEX alanı oluşturun.
// Her giriş, sol tarafta XE alanının Metin özelliği değerini görüntüler,
// ve sağ tarafta XE alanını içeren sayfanın numarası.
// XE alanlarının "Metin" özelliğinde aynı değer varsa,
// INDEX alanı bunları tek bir girdide gruplayacaktır.
FieldIndex index = (FieldIndex)builder.InsertField(FieldType.FieldIndex, true);
index.LanguageId = "1033";
// Bu özelliğin değerini "A" olarak ayarlamak tüm girdileri ilk harflerine göre gruplandıracaktır,
// ve her grubun üstüne o harfi büyük harfle yaz.
index.Heading = "A";
// INDEX alanıyla oluşturulan tabloyu 2 sütuna yayılacak şekilde ayarla.
index.NumberOfColumns = "2";
// "ac" karakter aralığının dışında başlayan harflere sahip tüm girdilerin atlanmasını ayarla.
index.LetterRange = "a-c";
Assert.AreEqual(" INDEX \\z 1033 \\h A \\c 2 \\p a-c", index.GetFieldCode());
// Sonraki iki XE alanı "A" başlığı altında gösterilecektir.
// kendi metin stilleri sayfa numaralarına da uygulandı.
builder.InsertBreak(BreakType.PageBreak);
FieldXE indexEntry = (FieldXE)builder.InsertField(FieldType.FieldIndexEntry, true);
indexEntry.Text = "Apple";
indexEntry.IsItalic = true;
Assert.AreEqual(" XE Apple \\i", indexEntry.GetFieldCode());
builder.InsertBreak(BreakType.PageBreak);
indexEntry = (FieldXE)builder.InsertField(FieldType.FieldIndexEntry, true);
indexEntry.Text = "Apricot";
indexEntry.IsBold = true;
Assert.AreEqual(" XE Apricot \\b", indexEntry.GetFieldCode());
// Sonraki iki XE alanı, INDEX alanları içindekiler tablosunda "B" ve "C" başlığı altında yer alacaktır.
builder.InsertBreak(BreakType.PageBreak);
indexEntry = (FieldXE)builder.InsertField(FieldType.FieldIndexEntry, true);
indexEntry.Text = "Banana";
builder.InsertBreak(BreakType.PageBreak);
indexEntry = (FieldXE)builder.InsertField(FieldType.FieldIndexEntry, true);
indexEntry.Text = "Cherry";
// INDEX alanları tüm girdileri alfabetik olarak sıralar, bu nedenle bu girdi diğer ikisiyle birlikte "A" altında gösterilir.
builder.InsertBreak(BreakType.PageBreak);
indexEntry = (FieldXE)builder.InsertField(FieldType.FieldIndexEntry, true);
indexEntry.Text = "Avocado";
// Bu giriş "D" harfiyle başladığı için görünmeyecektir.
// INDEX alanının LetterRange özelliğinin tanımladığı "ac" karakter aralığının dışındadır.
builder.InsertBreak(BreakType.PageBreak);
indexEntry = (FieldXE)builder.InsertField(FieldType.FieldIndexEntry, true);
indexEntry.Text = "Durian";
doc.UpdatePageLayout();
doc.UpdateFields();
doc.Save(ArtifactsDir + "Field.INDEX.XE.Formatting.docx");
Ayrıca bakınız
- class Field
- ad alanı Aspose.Words.Fields
- toplantı Aspose.Words
