Aspose::Words::Fields::FieldFileSize class

FieldFileSize class

Implements the FILESIZE field. To learn more, visit the Working with Fields documentation article.

class FieldFileSize : public Field,
                      public IFieldCodeTokenInfoProvider

Methods

MethodDescription
get_IsInKilobytes()Gets or sets whether to display the file size in kilobytes.
get_IsInMegabytes()Gets or sets whether to display the file size in megabytes.
set_IsInKilobytes(bool)Sets whether to display the file size in kilobytes.
set_IsInMegabytes(bool)Sets whether to display the file size in megabytes.
GetFieldCode()Returns text between field start and field separator (or field end if there is no separator). Both field code and field result of child fields are included.
GetFieldCode(bool)Returns text between field start and field separator (or field end if there is no separator).
virtual Remove()Removes the field from the document. Returns a node right after the field. If the field’s end is the last child of its parent node, returns its parent paragraph. If the field is already removed, returns null.
Unlink()Performs the field unlink.
Update()Performs the field update. Throws if the field is being updated already.
Update(bool)Performs a field update. Throws if the field is being updated already.
get_DisplayResult()Gets the text that represents the displayed field result.
get_End() constGets the node that represents the field end.
get_Format()Gets a FieldFormat object that provides typed access to field’s formatting.
get_IsDirty()Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
get_IsLocked()Gets or sets whether the field is locked (should not recalculate its result).
get_LocaleId()Gets or sets the LCID of the field.
get_Result()Gets or sets text that is between the field separator and field end.
get_Separator()Gets the node that represents the field separator. Can be null.
get_Start() constGets the node that represents the start of the field.
virtual get_Type() constGets the Microsoft Word field type.
set_IsDirty(bool)Sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
set_IsLocked(bool)Sets whether the field is locked (should not recalculate its result).
set_LocaleId(int32_t)Sets the LCID of the field.
set_Result(const System::String &)Sets text that is between the field separator and field end.

Remarks

Retrieves the size of the current document’s file or 0 if the size cannot be determined.

In the current implementation, uses the OriginalFileName property to retrieve the file name used to determine the file size.

Examples

Shows how to display the file size of a document with a FILESIZE field.

auto doc = System::MakeObject<Aspose::Words::Document>(System::String(get_MyDir() + u"Document.docx"));

ASSERT_EQ(doc->get_BuiltInDocumentProperties()->get_Bytes(), 18105);

auto builder = System::MakeObject<Aspose::Words::DocumentBuilder>(doc);
builder->MoveToDocumentEnd();
builder->InsertParagraph();

// Below are three different units of measure
// with which FILESIZE fields can display the document's file size.
// 1 -  Bytes:
auto field = System::ExplicitCast<Aspose::Words::Fields::FieldFileSize>(builder->InsertField(FieldType::FieldFileSize, true));
field->Update();

ASSERT_EQ(field->GetFieldCode(), u" FILESIZE ");
ASSERT_EQ(field->get_Result(), u"18105");

// 2 -  Kilobytes:
builder->InsertParagraph();
field = System::ExplicitCast<Aspose::Words::Fields::FieldFileSize>(builder->InsertField(FieldType::FieldFileSize, true));
field->set_IsInKilobytes(true);
field->Update();

ASSERT_EQ(field->GetFieldCode(), u" FILESIZE  \\k");
ASSERT_EQ(field->get_Result(), u"18");

// 3 -  Megabytes:
builder->InsertParagraph();
field = System::ExplicitCast<Aspose::Words::Fields::FieldFileSize>(builder->InsertField(FieldType::FieldFileSize, true));
field->set_IsInMegabytes(true);
field->Update();

ASSERT_EQ(field->GetFieldCode(), u" FILESIZE  \\m");
ASSERT_EQ(field->get_Result(), u"0");

// To update the values of these fields while editing in Microsoft Word,
// we must first save the changes, and then manually update these fields.
doc->Save(get_ArtifactsDir() + u"Field.FILESIZE.docx");

See Also